com.opengamma.strata.product.index

Class ResolvedOvernightFutureTrade.Builder

java.lang.Object

org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ResolvedOvernightFutureTrade>

com.opengamma.strata.product.index.ResolvedOvernightFutureTrade.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<ResolvedOvernightFutureTrade>

Enclosing class:

ResolvedOvernightFutureTrade

public static final class ResolvedOvernightFutureTrade.Builder
extends org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ResolvedOvernightFutureTrade>

The bean-builder for ResolvedOvernightFutureTrade.

Method Summary

Modifier and Type	Method and Description
ResolvedOvernightFutureTrade	build()
Object	get(String propertyName)
ResolvedOvernightFutureTrade.Builder	info(PortfolioItemInfo info) Sets the additional information, defaulted to an empty instance.
ResolvedOvernightFutureTrade.Builder	product(ResolvedOvernightFuture product) Sets the future that was traded.
ResolvedOvernightFutureTrade.Builder	quantity(double quantity) Sets the quantity that was traded.
ResolvedOvernightFutureTrade.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
ResolvedOvernightFutureTrade.Builder	set(String propertyName, Object newValue)
String	toString()
ResolvedOvernightFutureTrade.Builder	tradedPrice(TradedPrice tradedPrice) Sets the price that was traded, together with the trade date, optional.

Methods inherited from class org.joda.beans.impl.direct.DirectFieldsBeanBuilder

get

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

get

public Object get(String propertyName)

Specified by:

get in interface org.joda.beans.BeanBuilder<ResolvedOvernightFutureTrade>

Overrides:

get in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ResolvedOvernightFutureTrade>

set

public ResolvedOvernightFutureTrade.Builder set(String propertyName,
                                                Object newValue)

set

public ResolvedOvernightFutureTrade.Builder set(org.joda.beans.MetaProperty<?> property,
                                                Object value)

Specified by:

set in interface org.joda.beans.BeanBuilder<ResolvedOvernightFutureTrade>

Overrides:

set in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ResolvedOvernightFutureTrade>

build

public ResolvedOvernightFutureTrade build()

info

public ResolvedOvernightFutureTrade.Builder info(PortfolioItemInfo info)

Sets the additional information, defaulted to an empty instance.

This allows additional information to be attached.

Parameters:

info - the new value, not null

Returns:

this, for chaining, not null

product

public ResolvedOvernightFutureTrade.Builder product(ResolvedOvernightFuture product)

Sets the future that was traded.

The product captures the contracted financial details of the trade.

Parameters:

product - the new value, not null

Returns:

this, for chaining, not null

quantity

public ResolvedOvernightFutureTrade.Builder quantity(double quantity)

Sets the quantity that was traded.

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

Parameters:

quantity - the new value

Returns:

this, for chaining, not null

tradedPrice

public ResolvedOvernightFutureTrade.Builder tradedPrice(TradedPrice tradedPrice)

Sets 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 Overnight rate futures in the trade model, pricers and market data. The decimal price is based on the decimal rate equivalent to the percentage. For example, a price of 99.32 implies an interest rate of 0.68% which is represented in Strata by 0.9932.

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.

Parameters:

tradedPrice - the new value

Returns:

this, for chaining, not null

toString

public String toString()

Overrides:

toString in class org.joda.beans.impl.direct.DirectFieldsBeanBuilder<ResolvedOvernightFutureTrade>