Package com.opengamma.strata.market.param

Class ResolvedTradeParameterMetadata

java.lang.Object

com.opengamma.strata.market.param.ResolvedTradeParameterMetadata

All Implemented Interfaces:

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

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

Parameter metadata based on a resolved trade and label.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResolvedTradeParameterMetadata.Builder	The bean-builder for ResolvedTradeParameterMetadata.
static class	ResolvedTradeParameterMetadata.Meta	The meta-bean for ResolvedTradeParameterMetadata.

Method Summary

Modifier and Type	Method	Description
static ResolvedTradeParameterMetadata.Builder	builder()	Returns a builder used to create an instance of the bean.
boolean	equals(Object obj)
String	getIdentifier()	Returns an object used to identify the parameter.
String	getLabel()	Gets the label that describes the parameter.
ResolvedTrade	getTrade()	Gets the trade that describes the parameter.
int	hashCode()
static ResolvedTradeParameterMetadata.Meta	meta()	The meta-bean for ResolvedTradeParameterMetadata.
ResolvedTradeParameterMetadata.Meta	metaBean()
static ResolvedTradeParameterMetadata	of(ResolvedTrade trade, String label)	Obtains an instance specifying the trade and label.
ResolvedTradeParameterMetadata.Builder	toBuilder()	Returns a builder that allows this bean to be mutated.
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 ResolvedTradeParameterMetadata of(ResolvedTrade trade,
                                                String label)

Obtains an instance specifying the trade and label.

Parameters:

trade - the resolved trade

label - the label

Returns:

the instance

getIdentifier

public String 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 ResolvedTradeParameterMetadata.Meta meta()

The meta-bean for ResolvedTradeParameterMetadata.

Returns:

the meta-bean, not null

builder

public static ResolvedTradeParameterMetadata.Builder builder()

Returns a builder used to create an instance of the bean.

Returns:

the builder, not null

metaBean

public ResolvedTradeParameterMetadata.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getTrade

public ResolvedTrade getTrade()

Gets the trade that describes the parameter.

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

toBuilder

public ResolvedTradeParameterMetadata.Builder toBuilder()

Returns a builder that allows this bean to be mutated.

Returns:

the mutable builder, not null

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