com.opengamma.strata.product.etd

Enum EtdSettlementType

java.lang.Object

java.lang.Enum<EtdSettlementType>

com.opengamma.strata.product.etd.EtdSettlementType

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<EtdSettlementType>

public enum EtdSettlementType
extends Enum<EtdSettlementType>
implements NamedEnum

The type of an Exchange Traded Derivative (ETD) settlement.

This is used for Flex options.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALTERNATE Alternate.
CASCADE Cascade.
CASH Cash settlement.
DERIVATIVE Derivative.
NOTIONAL Notional Settlement.
PAYMENT_VS_PAYMENT Payment-versus-Payment.
PHYSICAL Physical settlement.
STOCK Stock.

Method Summary

Modifier and Type	Method and Description
String	getCode() Gets the short code for the type.
static EtdSettlementType	of(String name) Obtains an instance from the specified name.
String	toString() Returns the formatted name of the type.
static EtdSettlementType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EtdSettlementType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.opengamma.strata.collect.named.NamedEnum

getName

Methods inherited from interface com.opengamma.strata.collect.named.Named

of

Enum Constant Detail

CASH

public static final EtdSettlementType CASH

Cash settlement.

PHYSICAL

public static final EtdSettlementType PHYSICAL

Physical settlement.

DERIVATIVE

public static final EtdSettlementType DERIVATIVE

Derivative.

NOTIONAL

public static final EtdSettlementType NOTIONAL

Notional Settlement.

PAYMENT_VS_PAYMENT

public static final EtdSettlementType PAYMENT_VS_PAYMENT

Payment-versus-Payment.

STOCK

public static final EtdSettlementType STOCK

Stock.

CASCADE

public static final EtdSettlementType CASCADE

Cascade.

ALTERNATE

public static final EtdSettlementType ALTERNATE

Alternate.

Method Detail

values

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

Returns:

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

valueOf

public static EtdSettlementType 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

of

public static EtdSettlementType of(String name)

Obtains an instance from the specified name.

Parsing handles the mixed case form produced by toString() and the upper and lower case variants of the enum constant name.

Parameters:

name - the name to parse

Returns:

the type

Throws:

IllegalArgumentException - if the name is not known

getCode

public String getCode()

Gets the short code for the type.

Returns:

the short code

toString

public String toString()

Returns the formatted name of the type.

Overrides:

toString in class Enum<EtdSettlementType>

Returns:

the formatted string representing the type