com.opengamma.strata.product

Enum PortfolioItemType

java.lang.Object

java.lang.Enum<PortfolioItemType>

com.opengamma.strata.product.PortfolioItemType

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<PortfolioItemType>

public enum PortfolioItemType
extends Enum<PortfolioItemType>
implements NamedEnum

The type of a portfolio item.

This allows trades, positions and sensitivities to be separated.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OTHER Any other kind of portfolio item.
POSITION A position.
SENSITIVITIES Risk expressed as sensitivities.
TRADE A trade.

Method Summary

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

TRADE

public static final PortfolioItemType TRADE

A trade.

A trade is a transaction that occurred on a specific date between two counterparties. See Trade.

POSITION

public static final PortfolioItemType POSITION

A position.

A position is effectively the sum of one or more trades in a Security. See Position.

SENSITIVITIES

public static final PortfolioItemType SENSITIVITIES

Risk expressed as sensitivities.

OTHER

public static final PortfolioItemType OTHER

Any other kind of portfolio item.

Method Detail

values

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

Returns:

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

valueOf

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

Returns:

the formatted string representing the type