com.opengamma.strata.basics.value

Class ValueStep.Builder

java.lang.Object

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

com.opengamma.strata.basics.value.ValueStep.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<ValueStep>

Enclosing class:

ValueStep

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

The bean-builder for ValueStep.

Method Summary

Modifier and Type	Method and Description
ValueStep	build()
ValueStep.Builder	date(LocalDate date) Sets the date of the schedule period boundary at which the change occurs.
Object	get(String propertyName)
ValueStep.Builder	periodIndex(Integer periodIndex) Sets the index of the schedule period boundary at which the change occurs.
ValueStep.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
ValueStep.Builder	set(String propertyName, Object newValue)
String	toString()
ValueStep.Builder	value(ValueAdjustment value) Sets the value representing the change that occurs.

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

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public ValueStep build()

periodIndex

public ValueStep.Builder periodIndex(Integer periodIndex)

Sets the index of the schedule period boundary at which the change occurs.

This property is used to define the date that the step occurs in relative terms. The date is identified by specifying the zero-based index of the schedule period boundary. The change will occur at the start of the specified period. Thus an index of zero is the start of the first period or initial stub. The index must be one or greater, as a change is not permitted at the start of the first period.

For example, consider a 5 year swap from 2012-02-01 to 2017-02-01 with 6 month frequency. A zero-based index of '2' would refer to start of the 3rd period, which would be 2013-02-01.

Parameters:

periodIndex - the new value

Returns:

this, for chaining, not null

date

public ValueStep.Builder date(LocalDate date)

Sets the date of the schedule period boundary at which the change occurs.

This property is used to define the date that the step occurs in absolute terms. This must be one of the unadjusted dates in the schedule period schedule. This is an unadjusted date and calculation period business day adjustments will apply.

For example, consider a 5 year swap from 2012-02-01 to 2017-02-01 with 6 month frequency. The date '2013-02-01' is an unadjusted schedule period boundary, and so may be specified here.

Parameters:

date - the new value

Returns:

this, for chaining, not null

value

public ValueStep.Builder value(ValueAdjustment value)

Sets the value representing the change that occurs.

The adjustment can be an absolute value, or various kinds of relative values.

Parameters:

value - 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<ValueStep>