com.opengamma.strata.market.curve

Enum CurveNodeDateType

java.lang.Object

java.lang.Enum<CurveNodeDateType>

com.opengamma.strata.market.curve.CurveNodeDateType

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<CurveNodeDateType>

public enum CurveNodeDateType
extends Enum<CurveNodeDateType>
implements NamedEnum

The types of curve node date.

This is used to identify how the date of a node should be calculated.

Enum Constant Summary

Enum Constants

Enum Constant and Description
END Defines the end date of the trade.
FIXED Defines a fixed date that is externally provided.
LAST_FIXING Defines the last fixing date referenced in the trade.

Method Summary

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

FIXED

public static final CurveNodeDateType FIXED

Defines a fixed date that is externally provided.

END

public static final CurveNodeDateType END

Defines the end date of the trade. This will typically be the last accrual date, but may be any suitable date at the end of the trade.

LAST_FIXING

public static final CurveNodeDateType LAST_FIXING

Defines the last fixing date referenced in the trade. Used only for instruments referencing an Ibor index.

Method Detail

values

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

Returns:

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

valueOf

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

Returns:

the formatted string representing the type