com.opengamma.strata.product.swap

Class ResolvedSwapLeg.Builder

java.lang.Object

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

com.opengamma.strata.product.swap.ResolvedSwapLeg.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<ResolvedSwapLeg>

Enclosing class:

ResolvedSwapLeg

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

The bean-builder for ResolvedSwapLeg.

Method Summary

Modifier and Type	Method and Description
ResolvedSwapLeg	build()
Object	get(String propertyName)
ResolvedSwapLeg.Builder	paymentEvents(List<? extends SwapPaymentEvent> paymentEvents) Sets the payment events that are associated with the swap leg.
ResolvedSwapLeg.Builder	paymentEvents(SwapPaymentEvent... paymentEvents) Sets the paymentEvents property in the builder from an array of objects.
ResolvedSwapLeg.Builder	paymentPeriods(List<? extends SwapPaymentPeriod> paymentPeriods) Sets the payment periods that combine to form the swap leg.
ResolvedSwapLeg.Builder	paymentPeriods(SwapPaymentPeriod... paymentPeriods) Sets the paymentPeriods property in the builder from an array of objects.
ResolvedSwapLeg.Builder	payReceive(PayReceive payReceive) Sets whether the leg is pay or receive.
ResolvedSwapLeg.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
ResolvedSwapLeg.Builder	set(String propertyName, Object newValue)
String	toString()
ResolvedSwapLeg.Builder	type(SwapLegType type) Sets the type of the leg, such as Fixed or Ibor.

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

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public ResolvedSwapLeg build()

type

public ResolvedSwapLeg.Builder type(SwapLegType type)

Sets the type of the leg, such as Fixed or Ibor.

This provides a high level categorization of the swap leg.

Parameters:

type - the new value, not null

Returns:

this, for chaining, not null

payReceive

public ResolvedSwapLeg.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 interest 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

paymentPeriods

public ResolvedSwapLeg.Builder paymentPeriods(List<? extends SwapPaymentPeriod> paymentPeriods)

Sets the payment periods that combine to form the swap leg.

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.

The start date and end date of the leg are determined from the first and last period. As such, the periods should be sorted.

Parameters:

paymentPeriods - the new value, not empty

Returns:

this, for chaining, not null

paymentPeriods

public ResolvedSwapLeg.Builder paymentPeriods(SwapPaymentPeriod... paymentPeriods)

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

Parameters:

paymentPeriods - the new value, not empty

Returns:

this, for chaining, not null

paymentEvents

public ResolvedSwapLeg.Builder paymentEvents(List<? extends SwapPaymentEvent> paymentEvents)

Sets the payment events that are associated with the swap leg.

Payment events include notional exchange and fees.

Parameters:

paymentEvents - the new value, not null

Returns:

this, for chaining, not null

paymentEvents

public ResolvedSwapLeg.Builder paymentEvents(SwapPaymentEvent... paymentEvents)

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

Parameters:

paymentEvents - 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<ResolvedSwapLeg>