com.opengamma.strata.market.curve

Class CurveInfoType<T>

java.lang.Object

com.opengamma.strata.collect.TypedString<CurveInfoType<T>>

com.opengamma.strata.market.curve.CurveInfoType<T>

Type Parameters:

T - the type of the associated value

All Implemented Interfaces:

Named, Serializable, Comparable<CurveInfoType<T>>

public final class CurveInfoType<T>
extends TypedString<CurveInfoType<T>>

The type that provides meaning to additional curve information.

Additional curve information is stored in CurveMetadata. It provides the ability to associate arbitrary information with a curve in a key-value map. For example, it might be used to provide information about one of the axes.

Applications that wish to use curve information should declare a static constant declaring the CurveInfoType instance, the type parameter and an UpperCamelCase name. For example:

  public static final CurveInfoType<String> OWNER = CurveInfoType.of("Owner");
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static CurveInfoType<Double>	CDS_INDEX_FACTOR Key used to access information about the index factor.
static CurveInfoType<Integer>	COMPOUNDING_PER_YEAR Key used to access information about the number of compounding per year, as an Integer.
static CurveInfoType<DayCount>	DAY_COUNT Key used to access information about the DayCount.
static CurveInfoType<JacobianCalibrationMatrix>	JACOBIAN Key used to access information about the JacobianCalibrationMatrix.
static CurveInfoType<DoubleArray>	PV_SENSITIVITY_TO_MARKET_QUOTE Key used to access information about the present value sensitivity to market quote, represented by a DoubleArray.

Method Summary

Modifier and Type	Method and Description
static <T> CurveInfoType<T>	of(String name) 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

DAY_COUNT

public static final CurveInfoType<DayCount> DAY_COUNT

Key used to access information about the DayCount.

JACOBIAN

public static final CurveInfoType<JacobianCalibrationMatrix> JACOBIAN

Key used to access information about the JacobianCalibrationMatrix.

COMPOUNDING_PER_YEAR

public static final CurveInfoType<Integer> COMPOUNDING_PER_YEAR

Key used to access information about the number of compounding per year, as an Integer.

PV_SENSITIVITY_TO_MARKET_QUOTE

public static final CurveInfoType<DoubleArray> PV_SENSITIVITY_TO_MARKET_QUOTE

Key used to access information about the present value sensitivity to market quote, represented by a DoubleArray.

CDS_INDEX_FACTOR

public static final CurveInfoType<Double> CDS_INDEX_FACTOR

Key used to access information about the index factor.

Method Detail

of

public static <T> CurveInfoType<T> of(String name)

Obtains an instance from the specified name.

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

Type Parameters:

T - the type associated with the info

Parameters:

name - the name

Returns:

a type instance with the specified name