com.opengamma.strata.product.capfloor

Class OvernightInArrearsCapletFloorletPeriod.Builder

java.lang.Object

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

com.opengamma.strata.product.capfloor.OvernightInArrearsCapletFloorletPeriod.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<OvernightInArrearsCapletFloorletPeriod>

Enclosing class:

OvernightInArrearsCapletFloorletPeriod

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

The bean-builder for OvernightInArrearsCapletFloorletPeriod.

Method Summary

Modifier and Type	Method and Description
OvernightInArrearsCapletFloorletPeriod	build()
OvernightInArrearsCapletFloorletPeriod.Builder	caplet(Double caplet) Sets the optional caplet strike.
OvernightInArrearsCapletFloorletPeriod.Builder	currency(Currency currency) Sets the primary currency of the payment period.
OvernightInArrearsCapletFloorletPeriod.Builder	endDate(LocalDate endDate) Sets the end date of the payment period.
OvernightInArrearsCapletFloorletPeriod.Builder	floorlet(Double floorlet) Sets the optional floorlet strike.
Object	get(String propertyName)
OvernightInArrearsCapletFloorletPeriod.Builder	notional(double notional) Sets the notional amount, positive if receiving, negative if paying.
OvernightInArrearsCapletFloorletPeriod.Builder	overnightRate(OvernightCompoundedRateComputation overnightRate) Sets the rate to be observed.
OvernightInArrearsCapletFloorletPeriod.Builder	paymentDate(LocalDate paymentDate) Sets the date that payment occurs.
OvernightInArrearsCapletFloorletPeriod.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
OvernightInArrearsCapletFloorletPeriod.Builder	set(String propertyName, Object newValue)
OvernightInArrearsCapletFloorletPeriod.Builder	startDate(LocalDate startDate) Sets the start date of the payment period.
String	toString()
OvernightInArrearsCapletFloorletPeriod.Builder	unadjustedEndDate(LocalDate unadjustedEndDate) Sets the unadjusted end date.
OvernightInArrearsCapletFloorletPeriod.Builder	unadjustedStartDate(LocalDate unadjustedStartDate) Sets the unadjusted start date.
OvernightInArrearsCapletFloorletPeriod.Builder	yearFraction(double yearFraction) Sets the year fraction that the accrual period represents.

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

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public OvernightInArrearsCapletFloorletPeriod build()

currency

public OvernightInArrearsCapletFloorletPeriod.Builder currency(Currency currency)

Sets the primary currency of the payment period.

The amounts of the notional are usually expressed in terms of this currency, however they can be converted from amounts in a different currency.

Parameters:

currency - the new value, not null

Returns:

this, for chaining, not null

notional

public OvernightInArrearsCapletFloorletPeriod.Builder notional(double notional)

Sets the notional amount, positive if receiving, negative if paying.

The notional amount applicable during the period. The currency of the notional is specified by currency.

Parameters:

notional - the new value

Returns:

this, for chaining, not null

startDate

public OvernightInArrearsCapletFloorletPeriod.Builder startDate(LocalDate startDate)

Sets the start date of the payment period.

This is the first date in the period. If the schedule adjusts for business days, then this is the adjusted date.

Parameters:

startDate - the new value, not null

Returns:

this, for chaining, not null

endDate

public OvernightInArrearsCapletFloorletPeriod.Builder endDate(LocalDate endDate)

Sets the end date of the payment period.

This is the last date in the period. If the schedule adjusts for business days, then this is the adjusted date.

Parameters:

endDate - the new value, not null

Returns:

this, for chaining, not null

unadjustedStartDate

public OvernightInArrearsCapletFloorletPeriod.Builder unadjustedStartDate(LocalDate unadjustedStartDate)

Sets the unadjusted start date.

The start date before any business day adjustment is applied.

When building, this will default to the start date if not specified.

Parameters:

unadjustedStartDate - the new value, not null

Returns:

this, for chaining, not null

unadjustedEndDate

public OvernightInArrearsCapletFloorletPeriod.Builder unadjustedEndDate(LocalDate unadjustedEndDate)

Sets the unadjusted end date.

The end date before any business day adjustment is applied.

When building, this will default to the end date if not specified.

Parameters:

unadjustedEndDate - the new value, not null

Returns:

this, for chaining, not null

yearFraction

public OvernightInArrearsCapletFloorletPeriod.Builder yearFraction(double yearFraction)

Sets the year fraction that the accrual period represents.

The value is usually calculated using a DayCount which may be different to that of the index. Typically the value will be close to 1 for one year and close to 0.5 for six months. The fraction may be greater than 1, but not less than 0.

Parameters:

yearFraction - the new value

Returns:

this, for chaining, not null

paymentDate

public OvernightInArrearsCapletFloorletPeriod.Builder paymentDate(LocalDate paymentDate)

Sets the date that payment occurs.

If the schedule adjusts for business days, then this is the adjusted date.

Parameters:

paymentDate - the new value, not null

Returns:

this, for chaining, not null

caplet

public OvernightInArrearsCapletFloorletPeriod.Builder caplet(Double caplet)

Sets the optional caplet strike.

This defines the strike value of a caplet.

If the period is not a caplet, this field will be absent.

Parameters:

caplet - the new value

Returns:

this, for chaining, not null

floorlet

public OvernightInArrearsCapletFloorletPeriod.Builder floorlet(Double floorlet)

Sets the optional floorlet strike.

This defines the strike value of a floorlet.

If the period is not a floorlet, this field will be absent.

Parameters:

floorlet - the new value

Returns:

this, for chaining, not null

overnightRate

public OvernightInArrearsCapletFloorletPeriod.Builder overnightRate(OvernightCompoundedRateComputation overnightRate)

Sets the rate to be observed.

The value of the period is based on this overnight compounded rate.

Parameters:

overnightRate - the new value, not null

Returns:

this, for chaining, not null

toString

public String toString()

Overrides:

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