Package com.opengamma.strata.market.curve

Class RatesCurveGroupId

java.lang.Object

com.opengamma.strata.market.curve.RatesCurveGroupId

All Implemented Interfaces:

MarketDataId<RatesCurveGroup>, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class RatesCurveGroupId
extends Object
implements MarketDataId<RatesCurveGroup>, org.joda.beans.ImmutableBean, Serializable

An identifier used to access a curve group by name.

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

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
CurveGroupName	getCurveGroupName()	Gets the curve group name.
Class<RatesCurveGroup>	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<RatesCurveGroupId>	meta()	The meta-bean for RatesCurveGroupId.
org.joda.beans.TypedMetaBean<RatesCurveGroupId>	metaBean()
static RatesCurveGroupId	of(CurveGroupName groupName)	Obtains an instance used to obtain a curve group by name.
static RatesCurveGroupId	of(CurveGroupName groupName, ObservableSource obsSource)	Obtains an instance used to obtain a curve group by name, specifying the source of observable market data.
static RatesCurveGroupId	of(String groupName)	Obtains an instance used to obtain a curve group 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 RatesCurveGroupId of(String groupName)

Obtains an instance used to obtain a curve group by name.

Parameters:

groupName - the curve group name

Returns:

the identifier

of

public static RatesCurveGroupId of(CurveGroupName groupName)

Obtains an instance used to obtain a curve group by name.

Parameters:

groupName - the curve group name

Returns:

the identifier

of

public static RatesCurveGroupId of(CurveGroupName groupName,
                                   ObservableSource obsSource)

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

Parameters:

groupName - the curve group name

obsSource - source of observable market data

Returns:

the identifier

getMarketDataType

public Class<RatesCurveGroup> getMarketDataType()

Description copied from interface: MarketDataId

Gets the type of data this identifier refers to.

Specified by:

getMarketDataType in interface MarketDataId<RatesCurveGroup>

Returns:

the type of the market data this identifier refers to

toString

public String toString()

Overrides:

toString in class Object

meta

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

The meta-bean for RatesCurveGroupId.

Returns:

the meta-bean, not null

metaBean

public org.joda.beans.TypedMetaBean<RatesCurveGroupId> 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

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