Package com.opengamma.strata.product.etd

Enum EtdOptionType

java.lang.Object

java.lang.Enum<EtdOptionType>

com.opengamma.strata.product.etd.EtdOptionType

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<EtdOptionType>

public enum EtdOptionType
extends Enum<EtdOptionType>
implements NamedEnum

The option expiry type, 'American' or 'European'.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMERICAN	American option.
EUROPEAN	European option.

Method Summary

Modifier and Type	Method	Description
String	getCode()	Gets the short code for the type.
static EtdOptionType	of(String name)	Obtains an instance from the specified name.
String	toString()	Returns the formatted name of the type.
static EtdOptionType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EtdOptionType[]	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

Enum Constant Detail

AMERICAN

public static final EtdOptionType AMERICAN

American option. Can be exercised on any date during its life.

EUROPEAN

public static final EtdOptionType EUROPEAN

European option. Can be exercised only on a single date.

Method Detail

values

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

Returns:

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

valueOf

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

Returns:

the formatted string representing the type