Package com.opengamma.strata.market.curve

Enum CurveNodeClashAction

java.lang.Object

java.lang.Enum<CurveNodeClashAction>

com.opengamma.strata.market.curve.CurveNodeClashAction

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<CurveNodeClashAction>

public enum CurveNodeClashAction
extends Enum<CurveNodeClashAction>
implements NamedEnum

The action to perform when the dates of two curve nodes clash.

See CurveNodeDateOrder for more details.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DROP_OTHER	When a clash occurs, the other node is dropped.
DROP_THIS	When a clash occurs, this node is dropped.
EXCEPTION	When a clash occurs, an exception is thrown.

Method Summary

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

EXCEPTION

public static final CurveNodeClashAction EXCEPTION

When a clash occurs, an exception is thrown.

DROP_THIS

public static final CurveNodeClashAction DROP_THIS

When a clash occurs, this node is dropped.

DROP_OTHER

public static final CurveNodeClashAction DROP_OTHER

When a clash occurs, the other node is dropped.

Method Detail

values

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

Returns:

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

valueOf

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

Returns:

the formatted string representing the type