Package com.opengamma.strata.market.curve

Class CurveId

java.lang.Object

com.opengamma.strata.market.curve.CurveId

All Implemented Interfaces:

MarketDataId<Curve>, NamedMarketDataId<Curve>, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class CurveId
extends Object
implements NamedMarketDataId<Curve>, org.joda.beans.ImmutableBean, Serializable

An identifier used to access a curve by name.

This is used when there is a need to obtain an instance of Curve.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
CurveGroupName	getCurveGroupName()	Gets the curve group name.
CurveName	getCurveName()	Gets the curve name.
MarketDataName<Curve>	getMarketDataName()	Gets the market data name.
Class<Curve>	getMarketDataType()	Gets the type of data this identifier refers to.
ObservableSource	getObservableSource()	Gets the source of observable market data.
int	hashCode()
static org.joda.beans.TypedMetaBean<CurveId>	meta()	The meta-bean for CurveId.
org.joda.beans.TypedMetaBean<CurveId>	metaBean()
static CurveId	of(CurveGroupName groupName, CurveName curveName)	Obtains an instance used to obtain a curve by name.
static CurveId	of(CurveGroupName groupName, CurveName curveName, ObservableSource obsSource)	Obtains an instance used to obtain a curve by name, specifying the source of observable market data.
static CurveId	of(String groupName, String curveName)	Obtains an instance used to obtain a curve by name.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

of

public static CurveId of(String groupName,
                         String curveName)

Obtains an instance used to obtain a curve by name.

Parameters:

groupName - the curve group name

curveName - the curve name

Returns:

the identifier

of

public static CurveId of(CurveGroupName groupName,
                         CurveName curveName)

Obtains an instance used to obtain a curve by name.

Parameters:

groupName - the curve group name

curveName - the curve name

Returns:

the identifier

of

public static CurveId of(CurveGroupName groupName,
                         CurveName curveName,
                         ObservableSource obsSource)

Obtains an instance used to obtain a curve by name, specifying the source of observable market data.

Parameters:

groupName - the curve group name

curveName - the curve name

obsSource - the source of observable market data

Returns:

the identifier

getMarketDataType

public Class<Curve> getMarketDataType()

Description copied from interface: MarketDataId

Gets the type of data this identifier refers to.

Specified by:

getMarketDataType in interface MarketDataId<Curve>

Returns:

the type of the market data this identifier refers to

getMarketDataName

public MarketDataName<Curve> getMarketDataName()

Description copied from interface: NamedMarketDataId

Gets the market data name.

This name can be used to obtain the market data within a single coherent data set.

Specified by:

getMarketDataName in interface NamedMarketDataId<Curve>

Returns:

the name of the market data this identifier refers to

toString

public String toString()

Overrides:

toString in class Object

meta

public static org.joda.beans.TypedMetaBean<CurveId> meta()

The meta-bean for CurveId.

Returns:

the meta-bean, not null

metaBean

public org.joda.beans.TypedMetaBean<CurveId> metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getCurveGroupName

public CurveGroupName getCurveGroupName()

Gets the curve group name.

Returns:

the value of the property, not null

getCurveName

public CurveName getCurveName()

Gets the curve name.

Returns:

the value of the property, not null

getObservableSource

public ObservableSource getObservableSource()

Gets the source of observable market data.

Returns:

the value of the property, not null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object