Package com.opengamma.strata.product.cms

Class CmsTrade

java.lang.Object

com.opengamma.strata.product.cms.CmsTrade

All Implemented Interfaces:

CalculationTarget, Resolvable<ResolvedCmsTrade>, PortfolioItem, ProductTrade, ResolvableTrade<ResolvedCmsTrade>, Trade, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class CmsTrade
extends Object
implements ProductTrade, ResolvableTrade<ResolvedCmsTrade>, org.joda.beans.ImmutableBean, Serializable

A trade in a constant maturity swap (CMS).

An Over-The-Counter (OTC) trade in a Cms.

For example, a CMS trade might involve an agreement to exchange the difference between the fixed rate of 1% and the swap rate of 5-year 'GBP-FIXED-6M-LIBOR-6M' swaps every 6 months for 2 years.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CmsTrade.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<AdjustablePayment>	getPremium()	Gets the optional premium of the product.
Cms	getProduct()	Gets the CMS product that was agreed when the trade occurred.
int	hashCode()
static CmsTrade.Meta	meta()	The meta-bean for CmsTrade.
CmsTrade.Meta	metaBean()
ResolvedCmsTrade	resolve(ReferenceData refData)	Resolves this trade using the specified reference data.
PortfolioItemSummary	summarize()	Summarizes the portfolio item.
CmsTrade.Builder	toBuilder()	Returns a builder that allows this bean to be mutated.
String	toString()
CmsTrade	withInfo(PortfolioItemInfo info)	Returns an instance with the specified info.

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

Methods inherited from interface com.opengamma.strata.product.PortfolioItem

getId

Method Detail

withInfo

public CmsTrade withInfo(PortfolioItemInfo info)

Description copied from interface: ProductTrade

Returns an instance with the specified info.

Specified by:

withInfo in interface PortfolioItem

Specified by:

withInfo in interface ProductTrade

Specified by:

withInfo in interface ResolvableTrade<ResolvedCmsTrade>

Specified by:

withInfo in interface Trade

Parameters:

info - the new info

Returns:

the instance with the specified info

summarize

public PortfolioItemSummary summarize()

Description copied from interface: PortfolioItem

Summarizes the portfolio item.

This provides a summary, including a human readable description.

Specified by:

summarize in interface PortfolioItem

Specified by:

summarize in interface Trade

Returns:

the summary of the item

resolve

public ResolvedCmsTrade resolve(ReferenceData refData)

Description copied from interface: ResolvableTrade

Resolves this trade using the specified reference data.

This converts this trade to the equivalent resolved form. All ReferenceDataId identifiers in this instance will be resolved. The resulting ResolvedTrade is optimized for pricing.

Resolved objects may be 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.

Specified by:

resolve in interface Resolvable<ResolvedCmsTrade>

Specified by:

resolve in interface ResolvableTrade<ResolvedCmsTrade>

Parameters:

refData - the reference data to use when resolving

Returns:

the resolved trade

meta

public static CmsTrade.Meta meta()

The meta-bean for CmsTrade.

Returns:

the meta-bean, not null

builder

public static CmsTrade.Builder builder()

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

Returns:

the builder, not null

metaBean

public CmsTrade.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 PortfolioItem

Specified by:

getInfo in interface Trade

Returns:

the value of the property, not null

getProduct

public Cms getProduct()

Gets the CMS product that was agreed when the trade occurred.

The product captures the contracted financial details of the trade.

Specified by:

getProduct in interface ProductTrade

Returns:

the value of the property, not null

getPremium

public Optional<AdjustablePayment> 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 CmsTrade.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