com.opengamma.strata.product.cms

Class ResolvedCmsLeg.Builder

java.lang.Object

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

com.opengamma.strata.product.cms.ResolvedCmsLeg.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<ResolvedCmsLeg>

Enclosing class:

ResolvedCmsLeg

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

The bean-builder for ResolvedCmsLeg.

Method Summary

Modifier and Type	Method and Description
ResolvedCmsLeg	build()
ResolvedCmsLeg.Builder	cmsPeriods(CmsPeriod... cmsPeriods) Sets the cmsPeriods property in the builder from an array of objects.
ResolvedCmsLeg.Builder	cmsPeriods(List<CmsPeriod> cmsPeriods) Sets the periodic payments based on the successive observed values of a swap index.
Object	get(String propertyName)
ResolvedCmsLeg.Builder	payReceive(PayReceive payReceive) Sets whether the leg is pay or receive.
ResolvedCmsLeg.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
ResolvedCmsLeg.Builder	set(String propertyName, Object newValue)
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<ResolvedCmsLeg>

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public ResolvedCmsLeg build()

payReceive

public ResolvedCmsLeg.Builder payReceive(PayReceive payReceive)

Sets whether the leg is pay or receive.

A value of 'Pay' implies that the resulting amount is paid to the counterparty. A value of 'Receive' implies that the resulting amount is received from the counterparty. Note that negative swap rates can result in a payment in the opposite direction to that implied by this indicator.

The value of this flag should match the signs of the payment period notionals.

Parameters:

payReceive - the new value, not null

Returns:

this, for chaining, not null

cmsPeriods

public ResolvedCmsLeg.Builder cmsPeriods(List<CmsPeriod> cmsPeriods)

Sets the periodic payments based on the successive observed values of a swap index.

Each payment period represents part of the life-time of the leg. In most cases, the periods do not overlap. However, since each payment period is essentially independent the data model allows overlapping periods.

Parameters:

cmsPeriods - the new value, not empty

Returns:

this, for chaining, not null

cmsPeriods

public ResolvedCmsLeg.Builder cmsPeriods(CmsPeriod... cmsPeriods)

Sets the cmsPeriods property in the builder from an array of objects.

Parameters:

cmsPeriods - the new value, not empty

Returns:

this, for chaining, not null

toString

public String toString()

Overrides:

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