com.opengamma.strata.market.param

Class TenorTenorStrikeParameterMetadata

java.lang.Object

com.opengamma.strata.market.param.TenorTenorStrikeParameterMetadata

All Implemented Interfaces:

ParameterMetadata, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class TenorTenorStrikeParameterMetadata
extends Object
implements ParameterMetadata, org.joda.beans.ImmutableBean, Serializable

Parameter metadata based on an expiry tenor, an underlying tenor and strike value.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TenorTenorStrikeParameterMetadata.Meta The meta-bean for TenorTenorStrikeParameterMetadata.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Tenor	getExpiryTenor() Gets the expiry tenor associated with the parameter.
Triple<Tenor,Tenor,Double>	getIdentifier() Returns an object used to identify the parameter.
String	getLabel() Gets the label that describes the parameter, defaulted to the both tenors and strike.
double	getStrike() Gets the strike value associated with the parameter.
Tenor	getUnderlyingTenor() Gets the underlying tenor associated with the parameter.
int	hashCode()
static TenorTenorStrikeParameterMetadata.Meta	meta() The meta-bean for TenorTenorStrikeParameterMetadata.
TenorTenorStrikeParameterMetadata.Meta	metaBean()
static TenorTenorStrikeParameterMetadata	of(Tenor expiryTenor, Tenor underlyingTenor, double strike) Creates node metadata with expiry tenor, underlying tenor and strike.
static TenorTenorStrikeParameterMetadata	of(Tenor expiryTenor, Tenor underlyingTenor, double strike, String label) Creates node metadata with expiry tenor, underlying tenor, strike and label.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opengamma.strata.market.param.ParameterMetadata

empty, listOfEmpty

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

of

public static TenorTenorStrikeParameterMetadata of(Tenor expiryTenor,
                                                   Tenor underlyingTenor,
                                                   double strike)

Creates node metadata with expiry tenor, underlying tenor and strike.

Parameters:

expiryTenor - the expiry tenor

underlyingTenor - the underlying

strike - the strike

Returns:

the metadata

of

public static TenorTenorStrikeParameterMetadata of(Tenor expiryTenor,
                                                   Tenor underlyingTenor,
                                                   double strike,
                                                   String label)

Creates node metadata with expiry tenor, underlying tenor, strike and label.

Parameters:

expiryTenor - the expiry tenor

underlyingTenor - the underlying

strike - the strike

label - the label

Returns:

the metadata

getIdentifier

public Triple<Tenor,Tenor,Double> getIdentifier()

Description copied from interface: ParameterMetadata

Returns an object used to identify the parameter.

A good choice of identifier is one that makes sense to the user and can easily be created as part of a scenario definition. For example, many nodes types are naturally identified by a tenor.

The identifier must satisfy the following criteria:

• It must be non-null
• It should be unique within a single data set
• It should have a sensible implementation of hashCode() and equals().

Otherwise the choice of identifier is free and the system makes no assumptions about it.

Specified by:

getIdentifier in interface ParameterMetadata

Returns:

an object used to uniquely identify the parameter within the data

meta

public static TenorTenorStrikeParameterMetadata.Meta meta()

The meta-bean for TenorTenorStrikeParameterMetadata.

Returns:

the meta-bean, not null

metaBean

public TenorTenorStrikeParameterMetadata.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getExpiryTenor

public Tenor getExpiryTenor()

Gets the expiry tenor associated with the parameter.

Returns:

the value of the property, not null

getUnderlyingTenor

public Tenor getUnderlyingTenor()

Gets the underlying tenor associated with the parameter.

Returns:

the value of the property, not null

getStrike

public double getStrike()

Gets the strike value associated with the parameter.

Returns:

the value of the property

getLabel

public String getLabel()

Gets the label that describes the parameter, defaulted to the both tenors and strike.

Specified by:

getLabel in interface ParameterMetadata

Returns:

the value of the property, not empty

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object