biz.onixs.cme.stp.handler

Enum UnderlyingPriceDeterminationMethod

java.lang.Object

java.lang.Enum<UnderlyingPriceDeterminationMethod>

biz.onixs.cme.stp.handler.UnderlyingPriceDeterminationMethod

All Implemented Interfaces:

Serializable, Comparable<UnderlyingPriceDeterminationMethod>

public enum UnderlyingPriceDeterminationMethod
extends Enum<UnderlyingPriceDeterminationMethod>

Specifies how the underlying price is determined at the point of option exercise. The underlying price may be set to the current settlement price, set to a special reference, set to the optimal value of the underlying during the defined period ("Look-back") or set to the average value of the underlying during the defined period ("Asian option").

Enum Constant Summary

Enum Constants

Enum Constant and Description
AverageValue Average value (Asian option).
None Default value.
OptimalValue Optimal value (Lookback).
Regular Regular.
SpecialReference Special reference.

Method Summary

Modifier and Type	Method and Description
static UnderlyingPriceDeterminationMethod	forValue(int value) Returns enum value for the int representation
int	getValue() Gets current value.
static UnderlyingPriceDeterminationMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static UnderlyingPriceDeterminationMethod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final UnderlyingPriceDeterminationMethod None

Default value. Do not use it directly.

Regular

public static final UnderlyingPriceDeterminationMethod Regular

Regular.

SpecialReference

public static final UnderlyingPriceDeterminationMethod SpecialReference

Special reference.

OptimalValue

public static final UnderlyingPriceDeterminationMethod OptimalValue

Optimal value (Lookback).

AverageValue

public static final UnderlyingPriceDeterminationMethod AverageValue

Average value (Asian option).

Method Detail

values

public static UnderlyingPriceDeterminationMethod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (UnderlyingPriceDeterminationMethod c : UnderlyingPriceDeterminationMethod.values())
    System.out.println(c);

Returns:

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

valueOf

public static UnderlyingPriceDeterminationMethod valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Gets current value.

Returns:

current value.

forValue

public static UnderlyingPriceDeterminationMethod forValue(int value)

Returns enum value for the int representation

Parameters:

value - value

Returns:

value.