Package com.opengamma.strata.pricer.swaption

Class SwaptionVolatilitiesId

java.lang.Object

com.opengamma.strata.pricer.swaption.SwaptionVolatilitiesId

All Implemented Interfaces:

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

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

An identifier used to access swaption volatilities by name.

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

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
MarketDataName<SwaptionVolatilities>	getMarketDataName()	Gets the market data name.
Class<SwaptionVolatilities>	getMarketDataType()	Gets the type of data this identifier refers to.
SwaptionVolatilitiesName	getName()	Gets the name of the volatilities.
int	hashCode()
static org.joda.beans.TypedMetaBean<SwaptionVolatilitiesId>	meta()	The meta-bean for SwaptionVolatilitiesId.
org.joda.beans.TypedMetaBean<SwaptionVolatilitiesId>	metaBean()
static SwaptionVolatilitiesId	of(SwaptionVolatilitiesName name)	Obtains an identifier used to find swaption volatilities.
static SwaptionVolatilitiesId	of(String name)	Obtains an identifier used to find swaption volatilities.
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 SwaptionVolatilitiesId of(String name)

Obtains an identifier used to find swaption volatilities.

Parameters:

name - the name

Returns:

an identifier for the volatilities

of

public static SwaptionVolatilitiesId of(SwaptionVolatilitiesName name)

Obtains an identifier used to find swaption volatilities.

Parameters:

name - the name

Returns:

an identifier for the volatilities

getMarketDataType

public Class<SwaptionVolatilities> getMarketDataType()

Description copied from interface: MarketDataId

Gets the type of data this identifier refers to.

Specified by:

getMarketDataType in interface MarketDataId<SwaptionVolatilities>

Returns:

the type of the market data this identifier refers to

getMarketDataName

public MarketDataName<SwaptionVolatilities> 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<SwaptionVolatilities>

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<SwaptionVolatilitiesId> meta()

The meta-bean for SwaptionVolatilitiesId.

Returns:

the meta-bean, not null

metaBean

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

Specified by:

metaBean in interface org.joda.beans.Bean

getName

public SwaptionVolatilitiesName getName()

Gets the name of the volatilities.

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