Package com.opengamma.strata.product.capfloor

Class IborCapFloorTrade.Builder

java.lang.Object

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

com.opengamma.strata.product.capfloor.IborCapFloorTrade.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<IborCapFloorTrade>

Enclosing class:

IborCapFloorTrade

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

The bean-builder for IborCapFloorTrade.

Method Summary

Modifier and Type	Method	Description
IborCapFloorTrade	build()
Object	get(String propertyName)
IborCapFloorTrade.Builder	info(TradeInfo info)	Sets the additional trade information, defaulted to an empty instance.
IborCapFloorTrade.Builder	premium(AdjustablePayment premium)	Sets the optional premium of the product.
IborCapFloorTrade.Builder	product(IborCapFloor product)	Sets the cap/floor product that was agreed when the trade occurred.
IborCapFloorTrade.Builder	set(String propertyName, Object newValue)
IborCapFloorTrade.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
String	toString()

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

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public IborCapFloorTrade build()

info

public IborCapFloorTrade.Builder info(TradeInfo info)

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

This allows additional information to be attached to the trade.

Parameters:

info - the new value, not null

Returns:

this, for chaining, not null

product

public IborCapFloorTrade.Builder product(IborCapFloor product)

Sets the cap/floor product that was agreed when the trade occurred.

The product captures the contracted financial details of the trade.

Parameters:

product - the new value, not null

Returns:

this, for chaining, not null

premium

public IborCapFloorTrade.Builder premium(AdjustablePayment premium)

Sets the optional premium of the product.

For most Ibor cap/floor 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.

Parameters:

premium - the new value

Returns:

this, for chaining, not null

toString

public String toString()

Overrides:

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