Package com.opengamma.strata.market.param

Class LabelDateParameterMetadata

java.lang.Object

com.opengamma.strata.market.param.LabelDateParameterMetadata

All Implemented Interfaces:

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

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

Parameter metadata based on a date and label.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
LocalDate	getDate()	Gets the date associated with the parameter.
String	getIdentifier()	Gets the identifier, which is the label.
String	getLabel()	Gets the label that describes the parameter.
int	hashCode()
static LabelDateParameterMetadata.Meta	meta()	The meta-bean for LabelDateParameterMetadata.
LabelDateParameterMetadata.Meta	metaBean()
static LabelDateParameterMetadata	of(LocalDate date)	Obtains an instance using the date.
static LabelDateParameterMetadata	of(LocalDate date, String label)	Obtains an instance using the date, specifying the label.
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 LabelDateParameterMetadata of(LocalDate date)

Obtains an instance using the date.

Parameters:

date - the date associated with the parameter

Returns:

the parameter metadata based on the date

of

public static LabelDateParameterMetadata of(LocalDate date,
                                            String label)

Obtains an instance using the date, specifying the label.

Parameters:

date - the date associated with the parameter

label - the label to use

Returns:

the parameter metadata based on the date and label

getIdentifier

public String getIdentifier()

Gets the identifier, which is the label.

Specified by:

getIdentifier in interface ParameterMetadata

Returns:

the label

meta

public static LabelDateParameterMetadata.Meta meta()

The meta-bean for LabelDateParameterMetadata.

Returns:

the meta-bean, not null

metaBean

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

getLabel

public String getLabel()

Gets the label that describes the parameter.

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