Package net.finmath.smartcontract.product.xml

Enum Class RealisedVarianceMethodEnum

java.lang.Object

java.lang.Enum<RealisedVarianceMethodEnum>

net.finmath.smartcontract.product.xml.RealisedVarianceMethodEnum

All Implemented Interfaces:

Serializable, Comparable<RealisedVarianceMethodEnum>, Constable

public enum RealisedVarianceMethodEnum
extends Enum<RealisedVarianceMethodEnum>

Java class for RealisedVarianceMethodEnum.

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

 <simpleType name="RealisedVarianceMethodEnum">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="Previous"/>
     <enumeration value="Last"/>
     <enumeration value="Both"/>
   </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
BOTH	For a return on day T, the observed prices on both T and T-1 must be in range
LAST	For a return on day T, the observed price on T must be in range.
PREVIOUS	For a return on day T, the observed price on T-1 must be in range.

Method Summary

Modifier and Type	Method	Description
static RealisedVarianceMethodEnum	fromValue(String v)
String	value()
static RealisedVarianceMethodEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RealisedVarianceMethodEnum[]	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

PREVIOUS

public static final RealisedVarianceMethodEnum PREVIOUS

For a return on day T, the observed price on T-1 must be in range.

LAST

public static final RealisedVarianceMethodEnum LAST

For a return on day T, the observed price on T must be in range.

BOTH

public static final RealisedVarianceMethodEnum BOTH

For a return on day T, the observed prices on both T and T-1 must be in range

Method Details

values

public static RealisedVarianceMethodEnum[] 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 RealisedVarianceMethodEnum 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 RealisedVarianceMethodEnum fromValue(String v)