com.opengamma.strata.market.param

Class TenorDateParameterMetadata

java.lang.Object

com.opengamma.strata.market.param.TenorDateParameterMetadata

All Implemented Interfaces:

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

public final class TenorDateParameterMetadata
extends Object
implements DatedParameterMetadata, TenoredParameterMetadata, org.joda.beans.ImmutableBean, Serializable

Parameter metadata based on a date and tenor.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
LocalDate	getDate() Gets the date associated with the parameter.
Tenor	getIdentifier() Gets the identifier, which is the tenor.
String	getLabel() Gets the label that describes the parameter, defaulted to the tenor.
Tenor	getTenor() Gets the tenor associated with the parameter.
int	hashCode()
static TenorDateParameterMetadata.Meta	meta() The meta-bean for TenorDateParameterMetadata.
TenorDateParameterMetadata.Meta	metaBean()
static TenorDateParameterMetadata	of(LocalDate date, Tenor tenor) Obtains an instance using the tenor.
static TenorDateParameterMetadata	of(LocalDate date, Tenor tenor, String label) Obtains an instance using the tenor, specifying the label.
String	toString()
TenorDateParameterMetadata	withTenor(Tenor tenor) Returns an instance with the tenor updated.

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 TenorDateParameterMetadata of(LocalDate date,
                                            Tenor tenor)

Obtains an instance using the tenor.

Parameters:

date - the date associated with the parameter

tenor - the tenor associated with the parameter

Returns:

the parameter metadata based on the tenor

of

public static TenorDateParameterMetadata of(LocalDate date,
                                            Tenor tenor,
                                            String label)

Obtains an instance using the tenor, specifying the label.

Parameters:

date - the date associated with the parameter

tenor - the tenor associated with the parameter

label - the label to use

Returns:

the parameter metadata based on the tenor

getIdentifier

public Tenor getIdentifier()

Gets the identifier, which is the tenor.

Specified by:

getIdentifier in interface ParameterMetadata

Returns:

the tenor

withTenor

public TenorDateParameterMetadata withTenor(Tenor tenor)

Description copied from interface: TenoredParameterMetadata

Returns an instance with the tenor updated.

Specified by:

withTenor in interface TenoredParameterMetadata

Parameters:

tenor - the tenor to update to

Returns:

the updated metadata

meta

public static TenorDateParameterMetadata.Meta meta()

The meta-bean for TenorDateParameterMetadata.

Returns:

the meta-bean, not null

metaBean

public TenorDateParameterMetadata.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getDate

public LocalDate getDate()

Gets the date associated with the parameter.

This is the date that is most closely associated with the parameter. The actual parameter is typically a year fraction based on a day count.

Specified by:

getDate in interface DatedParameterMetadata

Returns:

the value of the property, not null

getTenor

public Tenor getTenor()

Gets the tenor associated with the parameter.

Specified by:

getTenor in interface TenoredParameterMetadata

Returns:

the value of the property, not null

getLabel

public String getLabel()

Gets the label that describes the parameter, defaulted to the tenor.

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