com.opengamma.strata.product.cms

Class ResolvedCmsTrade

java.lang.Object

com.opengamma.strata.product.cms.ResolvedCmsTrade

All Implemented Interfaces:

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

public final class ResolvedCmsTrade
extends Object
implements ResolvedTrade, org.joda.beans.ImmutableBean, Serializable

A trade in a constant maturity swap (CMS), resolved for pricing.

This is the resolved form of CmsTrade and is the primary input to the pricers. Applications will typically create a ResolvedCmsTrade from a CmsTrade using CmsTrade.resolve(ReferenceData).

A ResolvedCmsTrade is bound to data that changes over time, such as holiday calendars. If the data changes, such as the addition of a new holiday, the resolved form will not be updated. Care must be taken when placing the resolved form in a cache or persistence layer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ResolvedCmsTrade.Builder	builder() Returns a builder used to create an instance of the bean.
boolean	equals(Object obj)
TradeInfo	getInfo() Gets the additional trade information, defaulted to an empty instance.
Optional<Payment>	getPremium() Gets the optional premium of the product.
ResolvedCms	getProduct() Gets the resolved CMS product.
int	hashCode()
static ResolvedCmsTrade.Meta	meta() The meta-bean for ResolvedCmsTrade.
ResolvedCmsTrade.Meta	metaBean()
ResolvedCmsTrade.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

meta

public static ResolvedCmsTrade.Meta meta()

The meta-bean for ResolvedCmsTrade.

Returns:

the meta-bean, not null

builder

public static ResolvedCmsTrade.Builder builder()

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

Returns:

the builder, not null

metaBean

public ResolvedCmsTrade.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getInfo

public TradeInfo getInfo()

Gets the additional trade information, defaulted to an empty instance.

This allows additional information to be attached to the trade.

Specified by:

getInfo in interface ResolvedTrade

Returns:

the value of the property, not null

getProduct

public ResolvedCms getProduct()

Gets the resolved CMS product.

The product captures the contracted financial details of the trade.

Specified by:

getProduct in interface ResolvedTrade

Returns:

the value of the property, not null

getPremium

public Optional<Payment> getPremium()

Gets the optional premium of the product.

For certain CMS products, a premium is paid upfront. This typically occurs instead of periodic payments based on fixed or Ibor rates over the lifetime of the product.

The premium sign must be compatible with the product Pay/Receive flag.

Returns:

the optional value of the property, not null

toBuilder

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