Package net.finmath.smartcontract.product.xml

Enum Class RoundingDirectionEnum

java.lang.Object

java.lang.Enum<RoundingDirectionEnum>

net.finmath.smartcontract.product.xml.RoundingDirectionEnum

All Implemented Interfaces:

Serializable, Comparable<RoundingDirectionEnum>, Constable

public enum RoundingDirectionEnum
extends Enum<RoundingDirectionEnum>

Java class for RoundingDirectionEnum.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="RoundingDirectionEnum">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="Up"/>
     <enumeration value="Down"/>
     <enumeration value="Nearest"/>
   </restriction>
 </simpleType>
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOWN	A fractional number will be rounded down to the specified number of decimal places (the precision).
NEAREST	A fractional number will be rounded either up or down to the specified number of decimal places (the precision) depending on its value.
UP	A fractional number will be rounded up to the specified number of decimal places (the precision).

Method Summary

Modifier and Type	Method	Description
static RoundingDirectionEnum	fromValue(String v)
String	value()
static RoundingDirectionEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RoundingDirectionEnum[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UP

public static final RoundingDirectionEnum UP

A fractional number will be rounded up to the specified number of decimal places (the precision). For example, 5.21 and 5.25 rounded up to 1 decimal place are 5.3 and 5.3 respectively.

DOWN

public static final RoundingDirectionEnum DOWN

A fractional number will be rounded down to the specified number of decimal places (the precision). For example, 5.29 and 5.25 rounded down to 1 decimal place are 5.2 and 5.2 respectively.

NEAREST

public static final RoundingDirectionEnum NEAREST

A fractional number will be rounded either up or down to the specified number of decimal places (the precision) depending on its value. For example, 5.24 would be rounded down to 5.2 and 5.25 would be rounded up to 5.3 if a precision of 1 decimal place were specified.

Method Details

values

public static RoundingDirectionEnum[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RoundingDirectionEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

fromValue

public static RoundingDirectionEnum fromValue(String v)