com.opengamma.strata.product.bond

Class ResolvedBondFutureOptionTrade

java.lang.Object

com.opengamma.strata.product.bond.ResolvedBondFutureOptionTrade

All Implemented Interfaces:

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

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

A trade in in an option on a futures contract based on a basket of fixed coupon bonds, resolved for pricing.

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

A ResolvedBondFutureOptionTrade 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.

Price

Strata uses decimal prices for bond futures options in the trade model, pricers and market data. This is coherent with the pricing of BondFuture.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ResolvedBondFutureOptionTrade.Builder	builder() Returns a builder used to create an instance of the bean.
boolean	equals(Object obj)
PortfolioItemInfo	getInfo() Gets the additional information, defaulted to an empty instance.
ResolvedBondFutureOption	getProduct() Gets the option that was traded.
double	getQuantity() Gets the quantity that was traded.
Optional<TradedPrice>	getTradedPrice() Gets the price that was traded, together with the trade date, optional.
int	hashCode()
static ResolvedBondFutureOptionTrade.Meta	meta() The meta-bean for ResolvedBondFutureOptionTrade.
ResolvedBondFutureOptionTrade.Meta	metaBean()
ResolvedBondFutureOptionTrade.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 ResolvedBondFutureOptionTrade.Meta meta()

The meta-bean for ResolvedBondFutureOptionTrade.

Returns:

the meta-bean, not null

builder

public static ResolvedBondFutureOptionTrade.Builder builder()

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

Returns:

the builder, not null

metaBean

public ResolvedBondFutureOptionTrade.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getInfo

public PortfolioItemInfo getInfo()

Gets the additional information, defaulted to an empty instance.

This allows additional information to be attached.

Specified by:

getInfo in interface ResolvedTrade

Returns:

the value of the property, not null

getProduct

public ResolvedBondFutureOption getProduct()

Gets the option that was traded.

The product captures the contracted financial details of the trade.

Specified by:

getProduct in interface ResolvedTrade

Returns:

the value of the property, not null

getQuantity

public double getQuantity()

Gets the quantity that was traded.

This is the number of contracts that were traded. This will be positive if buying and negative if selling.

Returns:

the value of the property

getTradedPrice

public Optional<TradedPrice> getTradedPrice()

Gets the price that was traded, together with the trade date, optional.

This is the price agreed when the trade occurred, in decimal form. Strata uses decimal prices for bond futures options in the trade model, pricers and market data. This is coherent with the pricing of BondFuture.

This is optional to allow the class to be used to price both trades and positions. When the instance represents a trade, the traded price should be present. When the instance represents a position, the traded price should be empty.

Returns:

the optional value of the property, not null

toBuilder

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