com.opengamma.strata.calc

Enum ReportingCurrencyType

java.lang.Object

java.lang.Enum<ReportingCurrencyType>

com.opengamma.strata.calc.ReportingCurrencyType

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<ReportingCurrencyType>

public enum ReportingCurrencyType
extends Enum<ReportingCurrencyType>
implements NamedEnum

The available types of reporting currency.

There are three options - 'Specific', 'Natural' and 'None'.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NATURAL The "natural" reporting currency.
NONE No currency conversion is to be performed.
SPECIFIC The specific reporting currency.

Method Summary

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

SPECIFIC

public static final ReportingCurrencyType SPECIFIC

The specific reporting currency. See ReportingCurrency.of(Currency).

NATURAL

public static final ReportingCurrencyType NATURAL

The "natural" reporting currency. See ReportingCurrency.NATURAL.

NONE

public static final ReportingCurrencyType NONE

No currency conversion is to be performed. See ReportingCurrency.NONE.

Method Detail

values

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

Returns:

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

valueOf

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

Returns:

the formatted string representing the type