com.opengamma.strata.pricer.common

Enum PriceType

java.lang.Object

java.lang.Enum<PriceType>

com.opengamma.strata.pricer.common.PriceType

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<PriceType>

public enum PriceType
extends Enum<PriceType>
implements NamedEnum

Enumerates the types of price that can be returned.

The price is usually clean or dirty. Financial instruments are often quoted in terms of clean price rather than dirty price.

The dirty price is the full price, which is typically the mark-to-market value of an instrument.

The clean price is computed from the dirty price by subtracting/adding accrued interest. Subtraction/addition is determined by the direction of accrued interest payment.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLEAN Clean price.
DIRTY Dirty price.

Method Summary

Modifier and Type	Method and Description
boolean	isCleanPrice() Check if the price type is 'Clean'.
static PriceType	of(String name) Obtains an instance from the specified name.
String	toString() Returns the formatted name of the type.
static PriceType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PriceType[]	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

CLEAN

public static final PriceType CLEAN

Clean price.

The accrued interest is removed from the full price.

DIRTY

public static final PriceType DIRTY

Dirty price.

The dirty price is the full price of an instrument.

Method Detail

values

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

Returns:

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

valueOf

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

isCleanPrice

public boolean isCleanPrice()

Check if the price type is 'Clean'.

Returns:

true if clean, false if dirty

toString

public String toString()

Returns the formatted name of the type.

Overrides:

toString in class Enum<PriceType>

Returns:

the formatted string representing the type