biz.onixs.cme.stp.handler

Enum SettlementMethod

java.lang.Object

java.lang.Enum<SettlementMethod>

biz.onixs.cme.stp.handler.SettlementMethod

All Implemented Interfaces:

Serializable, Comparable<SettlementMethod>

public enum SettlementMethod
extends Enum<SettlementMethod>

Settlement method for a contract. Can be used as an alternative to CFI Code value.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CashSettlementRequired Cash settlement required.
ElectionAtExercise Election at exercise.
None Default value.
PhysicalSettlementRequired Physical settlement required.

Method Summary

Modifier and Type	Method and Description
static SettlementMethod	forValue(String value) Returns enum value for the string representation
String	getValue() Gets current value.
static SettlementMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static SettlementMethod[]	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 SettlementMethod None

Default value. Do not use it directly.

CashSettlementRequired

public static final SettlementMethod CashSettlementRequired

Cash settlement required.

ElectionAtExercise

public static final SettlementMethod ElectionAtExercise

Election at exercise.

PhysicalSettlementRequired

public static final SettlementMethod PhysicalSettlementRequired

Physical settlement required.

Method Detail

values

public static SettlementMethod[] 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 (SettlementMethod c : SettlementMethod.values())
    System.out.println(c);

Returns:

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

valueOf

public static SettlementMethod 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 String getValue()

Gets current value.

Returns:

current value.

forValue

public static SettlementMethod forValue(String value)

Returns enum value for the string representation

Parameters:

value - value

Returns:

value.