Package com.opengamma.strata.product.etd

Enum EtdExpiryType

java.lang.Object

java.lang.Enum<EtdExpiryType>

com.opengamma.strata.product.etd.EtdExpiryType

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<EtdExpiryType>

public enum EtdExpiryType
extends Enum<EtdExpiryType>
implements NamedEnum

The expiry type of an Exchange Traded Derivative (ETD) product.

Most ETDs expire monthly, on a date calculated via a formula. Some ETDs expire weekly, or on a specific date, see EtdVariant for more details.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAILY	The ETD expires on a specified day-of-month.
MONTHLY	The ETD expires once a month on a standardized day.
WEEKLY	The ETD expires in a specific week of the month.

Method Summary

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

MONTHLY

public static final EtdExpiryType MONTHLY

The ETD expires once a month on a standardized day.

WEEKLY

public static final EtdExpiryType WEEKLY

The ETD expires in a specific week of the month. The week is specified by the date code in EtdVariant.

DAILY

public static final EtdExpiryType DAILY

The ETD expires on a specified day-of-month. The day-of-month is specified by the date code in EtdVariant.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Returns the formatted name of the type.

Overrides:

toString in class Enum<EtdExpiryType>

Returns:

the formatted string representing the type