com.opengamma.strata.basics.schedule

Class Schedule.Builder

java.lang.Object

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

com.opengamma.strata.basics.schedule.Schedule.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<Schedule>

Enclosing class:

Schedule

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

The bean-builder for Schedule.

Method Summary

Modifier and Type	Method and Description
Schedule	build()
Schedule.Builder	frequency(Frequency frequency) Sets the periodic frequency used when building the schedule.
Object	get(String propertyName)
Schedule.Builder	periods(List<SchedulePeriod> periods) Sets the schedule periods.
Schedule.Builder	periods(SchedulePeriod... periods) Sets the periods property in the builder from an array of objects.
Schedule.Builder	rollConvention(RollConvention rollConvention) Sets the roll convention used when building the schedule.
Schedule.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
Schedule.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<Schedule>

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public Schedule build()

periods

public Schedule.Builder periods(List<SchedulePeriod> periods)

Sets the schedule periods.

There will be at least one period. The periods are ordered from earliest to latest. It is intended that each period is adjacent to the next one, however each period is independent and non-adjacent periods are allowed.

Parameters:

periods - the new value, not empty

Returns:

this, for chaining, not null

periods

public Schedule.Builder periods(SchedulePeriod... periods)

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

Parameters:

periods - the new value, not empty

Returns:

this, for chaining, not null

frequency

public Schedule.Builder frequency(Frequency frequency)

Sets the periodic frequency used when building the schedule.

If the schedule was not built from a regular periodic frequency, then the frequency should be a suitable estimate.

Parameters:

frequency - the new value, not null

Returns:

this, for chaining, not null

rollConvention

public Schedule.Builder rollConvention(RollConvention rollConvention)

Sets the roll convention used when building the schedule.

If the schedule was not built from a regular periodic frequency, then the convention should be 'None'.

Parameters:

rollConvention - 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<Schedule>