Package com.opengamma.strata.product.swaption

Class SwaptionTrade

java.lang.Object

com.opengamma.strata.product.swaption.SwaptionTrade

All Implemented Interfaces:

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

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

A trade in an option on an underlying swap.

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

A swaption is a financial instrument that provides the option to enter into a swap at a future date. The option is European, exercised only on the exercise date.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SwaptionTrade.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.
AdjustablePayment	getPremium()	Gets the premium of the swaption.
Swaption	getProduct()	Gets the swaption product that was agreed when the trade occurred.
int	hashCode()
static SwaptionTrade.Meta	meta()	The meta-bean for SwaptionTrade.
SwaptionTrade.Meta	metaBean()
static SwaptionTrade	of(TradeInfo info, Swaption product, AdjustablePayment premium)	Obtains an instance of a Swaption trade with an adjustable payment.
static SwaptionTrade	of(TradeInfo info, Swaption product, Payment premium)	Obtains an instance of a Swaption trade with a fixed payment.
ResolvedSwaptionTrade	resolve(ReferenceData refData)	Resolves this trade using the specified reference data.
PortfolioItemSummary	summarize()	Summarizes the portfolio item.
SwaptionTrade.Builder	toBuilder()	Returns a builder that allows this bean to be mutated.
String	toString()
SwaptionTrade	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

of

public static SwaptionTrade of(TradeInfo info,
                               Swaption product,
                               Payment premium)

Obtains an instance of a Swaption trade with a fixed payment.

Parameters:

info - the trade info

product - the product

premium - the premium

Returns:

the trade

of

public static SwaptionTrade of(TradeInfo info,
                               Swaption product,
                               AdjustablePayment premium)

Obtains an instance of a Swaption trade with an adjustable payment.

Parameters:

info - the trade info

product - the product

premium - the premium

Returns:

the trade

withInfo

public SwaptionTrade 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<ResolvedSwaptionTrade>

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 ResolvedSwaptionTrade 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<ResolvedSwaptionTrade>

Specified by:

resolve in interface ResolvableTrade<ResolvedSwaptionTrade>

Parameters:

refData - the reference data to use when resolving

Returns:

the resolved trade

meta

public static SwaptionTrade.Meta meta()

The meta-bean for SwaptionTrade.

Returns:

the meta-bean, not null

builder

public static SwaptionTrade.Builder builder()

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

Returns:

the builder, not null

metaBean

public SwaptionTrade.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 Swaption getProduct()

Gets the swaption 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 AdjustablePayment getPremium()

Gets the premium of the swaption.

The premium sign should be compatible with the product Long/Short flag. This means that the premium is negative for long and positive for short.

Returns:

the value of the property, not null

toBuilder

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