Package com.opengamma.strata.basics.schedule

Class SchedulePeriod.Builder

java.lang.Object

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

com.opengamma.strata.basics.schedule.SchedulePeriod.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<SchedulePeriod>

Enclosing class:

SchedulePeriod

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

The bean-builder for SchedulePeriod.

Method Summary

Modifier and Type	Method	Description
SchedulePeriod	build()
SchedulePeriod.Builder	endDate(LocalDate endDate)	Sets the end date of this period, used for financial calculations such as interest accrual.
Object	get(String propertyName)
SchedulePeriod.Builder	set(String propertyName, Object newValue)
SchedulePeriod.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
SchedulePeriod.Builder	startDate(LocalDate startDate)	Sets the start date of this period, used for financial calculations such as interest accrual.
String	toString()
SchedulePeriod.Builder	unadjustedEndDate(LocalDate unadjustedEndDate)	Sets the unadjusted end date.
SchedulePeriod.Builder	unadjustedStartDate(LocalDate unadjustedStartDate)	Sets the unadjusted start date.

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

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public SchedulePeriod build()

startDate

public SchedulePeriod.Builder startDate(LocalDate startDate)

Sets the start date of this period, used for financial calculations such as interest accrual.

The first date in the schedule period, typically treated as inclusive. 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 SchedulePeriod.Builder endDate(LocalDate endDate)

Sets the end date of this period, used for financial calculations such as interest accrual.

The last date in the schedule period, typically treated as exclusive. 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 SchedulePeriod.Builder unadjustedStartDate(LocalDate unadjustedStartDate)

Sets the unadjusted start date.

The start date before any business day adjustment. If the schedule adjusts for business days, then this is typically the regular periodic date. If the schedule does not adjust for business days, then this is the same as the start date.

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 SchedulePeriod.Builder unadjustedEndDate(LocalDate unadjustedEndDate)

Sets the unadjusted end date.

The end date before any business day adjustment. If the schedule adjusts for business days, then this is typically the regular periodic date. If the schedule does not adjust for business days, then this is the same as the end date.

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

toString

public String toString()

Overrides:

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