com.opengamma.strata.product

Class ProductType

java.lang.Object

com.opengamma.strata.collect.TypedString<ProductType>

com.opengamma.strata.product.ProductType

All Implemented Interfaces:

Described, Named, Serializable, Comparable<ProductType>

public final class ProductType
extends TypedString<ProductType>
implements Described

The type of a portfolio item.

This provides a classification of the trade or position.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ProductType	BILL A Bill.
static ProductType	BOND A FixedCouponBond or CapitalIndexedBond.
static ProductType	BOND_FUTURE A BondFuture.
static ProductType	BOND_FUTURE_OPTION A BondFutureOption.
static ProductType	BULLET_PAYMENT A BulletPayment.
static ProductType	CALIBRATION A product only used for calibration.
static ProductType	CDS A Cds.
static ProductType	CDS_INDEX A CdsIndex.
static ProductType	CMS A Cms.
static ProductType	DSF A Dsf.
static ProductType	ETD_FUTURE An EtdFutureSecurity.
static ProductType	ETD_OPTION A EtdOptionSecurity.
static ProductType	FRA A Fra.
static ProductType	FX_NDF A FxNdf.
static ProductType	FX_SINGLE A FxSingle.
static ProductType	FX_SINGLE_BARRIER_OPTION A FxSingleBarrierOption.
static ProductType	FX_SWAP A FxSwap.
static ProductType	FX_VANILLA_OPTION A FxVanillaOption.
static ProductType	IBOR_CAP_FLOOR A IborCapFloor.
static ProductType	IBOR_FUTURE A IborFuture.
static ProductType	IBOR_FUTURE_OPTION A IborFutureOption.
static ProductType	OTHER Another kind of product, details not known.
static ProductType	OVERNIGHT_FUTURE A OvernightFuture.
static ProductType	OVERNIGHT_FUTURE_OPTION A OvernightFutureOption.
static ProductType	SECURITY A Security, used where the kind of security is not known.
static ProductType	SENSITIVITIES A representation based on sensitivities.
static ProductType	SWAP A Swap.
static ProductType	SWAPTION A Swaption.
static ProductType	TERM_DEPOSIT A TermDeposit.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets the human-readable description of the type.
static ProductType	of(String name) Obtains an instance from the specified name.
static ProductType	of(String name, String description) Obtains an instance from the specified name.

Methods inherited from class com.opengamma.strata.collect.TypedString

compareTo, equals, getName, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.opengamma.strata.collect.named.Named

of

Field Detail

BULLET_PAYMENT

public static final ProductType BULLET_PAYMENT

A BulletPayment.

BILL

public static final ProductType BILL

A Bill.

BOND

public static final ProductType BOND

A FixedCouponBond or CapitalIndexedBond.

BOND_FUTURE

public static final ProductType BOND_FUTURE

A BondFuture.

BOND_FUTURE_OPTION

public static final ProductType BOND_FUTURE_OPTION

A BondFutureOption.

CDS

public static final ProductType CDS

A Cds.

CDS_INDEX

public static final ProductType CDS_INDEX

A CdsIndex.

CMS

public static final ProductType CMS

A Cms.

DSF

public static final ProductType DSF

A Dsf.

FRA

public static final ProductType FRA

A Fra.

FX_NDF

public static final ProductType FX_NDF

A FxNdf.

FX_SINGLE_BARRIER_OPTION

public static final ProductType FX_SINGLE_BARRIER_OPTION

A FxSingleBarrierOption.

FX_SINGLE

public static final ProductType FX_SINGLE

A FxSingle.

FX_SWAP

public static final ProductType FX_SWAP

A FxSwap.

FX_VANILLA_OPTION

public static final ProductType FX_VANILLA_OPTION

A FxVanillaOption.

IBOR_CAP_FLOOR

public static final ProductType IBOR_CAP_FLOOR

A IborCapFloor.

IBOR_FUTURE

public static final ProductType IBOR_FUTURE

A IborFuture.

IBOR_FUTURE_OPTION

public static final ProductType IBOR_FUTURE_OPTION

A IborFutureOption.

OVERNIGHT_FUTURE

public static final ProductType OVERNIGHT_FUTURE

A OvernightFuture.

OVERNIGHT_FUTURE_OPTION

public static final ProductType OVERNIGHT_FUTURE_OPTION

A OvernightFutureOption.

SENSITIVITIES

public static final ProductType SENSITIVITIES

A representation based on sensitivities.

SWAP

public static final ProductType SWAP

A Swap.

SWAPTION

public static final ProductType SWAPTION

A Swaption.

TERM_DEPOSIT

public static final ProductType TERM_DEPOSIT

A TermDeposit.

ETD_FUTURE

public static final ProductType ETD_FUTURE

An EtdFutureSecurity.

ETD_OPTION

public static final ProductType ETD_OPTION

A EtdOptionSecurity.

SECURITY

public static final ProductType SECURITY

A Security, used where the kind of security is not known.

CALIBRATION

public static final ProductType CALIBRATION

A product only used for calibration.

OTHER

public static final ProductType OTHER

Another kind of product, details not known.

Method Detail

of

public static ProductType of(String name)

Obtains an instance from the specified name.

The name may contain any character, but must not be empty.

Parameters:

name - the name

Returns:

a type instance with the specified name

of

public static ProductType of(String name,
                             String description)

Obtains an instance from the specified name.

The name may contain any character, but must not be empty.

Parameters:

name - the name

description - the description

Returns:

a type instance with the specified name

getDescription

public String getDescription()

Gets the human-readable description of the type.

Specified by:

getDescription in interface Described

Returns:

the description