com.opengamma.strata.market.param

Class TenorTenorParameterMetadata

java.lang.Object

com.opengamma.strata.market.param.TenorTenorParameterMetadata

All Implemented Interfaces:

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

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

Parameter metadata based on an expiry tenor, an underlying tenor and their respective year fractions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Tenor	getExpiryTenor() Gets the expiry tenor associated with the parameter.
Pair<Tenor,Tenor>	getIdentifier() Returns an object used to identify the parameter.
String	getLabel() Gets the label that describes the parameter, defaulted to both tenors.
Tenor	getUnderlyingTenor() Gets the underlying tenor associated with the parameter.
int	hashCode()
static TenorTenorParameterMetadata.Meta	meta() The meta-bean for TenorTenorParameterMetadata.
TenorTenorParameterMetadata.Meta	metaBean()
static TenorTenorParameterMetadata	of(Tenor expiryTenor, Tenor underlyingTenor) Creates node metadata with expiry tenor and underlying tenor.
static TenorTenorParameterMetadata	of(Tenor expiryTenor, Tenor underlyingTenor, String label) Creates node metadata with expiry tenor, underlying tenor 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 TenorTenorParameterMetadata of(Tenor expiryTenor,
                                             Tenor underlyingTenor)

Creates node metadata with expiry tenor and underlying tenor.

Parameters:

expiryTenor - the expiry tenor

underlyingTenor - the underlying

Returns:

the metadata

of

public static TenorTenorParameterMetadata of(Tenor expiryTenor,
                                             Tenor underlyingTenor,
                                             String label)

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

Parameters:

expiryTenor - the expiry tenor

underlyingTenor - the underlying

label - the label

Returns:

the metadata

getIdentifier

public Pair<Tenor,Tenor> 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 TenorTenorParameterMetadata.Meta meta()

The meta-bean for TenorTenorParameterMetadata.

Returns:

the meta-bean, not null

metaBean

public TenorTenorParameterMetadata.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

getLabel

public String getLabel()

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

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