Package com.opengamma.strata.report.framework.expression

Enum ValueRootType

java.lang.Object

java.lang.Enum<ValueRootType>

com.opengamma.strata.report.framework.expression.ValueRootType

All Implemented Interfaces:

Serializable, Comparable<ValueRootType>

public enum ValueRootType
extends Enum<ValueRootType>

Enumerates the possible value path roots.

Enum Constant Summary

Enum Constants

Enum Constant	Description
MEASURES	Refers to the set of possible calculated measures.
POSITION	Refers to the position.
PRODUCT	Refers to the product on the trade.
SECURITY	Refers to the security on the trade.
TARGET	Refers to the target (trade or position).
TRADE	Refers to the trade.

Method Summary

Modifier and Type	Method	Description
static ValueRootType	parseToken(String rootString)	Parses a string into the corresponding root type.
String	token()	Gets the token that the root type corresponds to.
static ValueRootType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ValueRootType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MEASURES

public static final ValueRootType MEASURES

Refers to the set of possible calculated measures.

PRODUCT

public static final ValueRootType PRODUCT

Refers to the product on the trade.

SECURITY

public static final ValueRootType SECURITY

Refers to the security on the trade.

TRADE

public static final ValueRootType TRADE

Refers to the trade.

POSITION

public static final ValueRootType POSITION

Refers to the position.

TARGET

public static final ValueRootType TARGET

Refers to the target (trade or position).

Method Detail

values

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

Returns:

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

valueOf

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

token

public String token()

Gets the token that the root type corresponds to.

Returns:

the token

parseToken

public static ValueRootType parseToken(String rootString)

Parses a string into the corresponding root type.

Parameters:

rootString - the token

Returns:

the root type corresponding to the given string