com.opengamma.strata.basics.index

Class ImmutableFxIndex.Builder

java.lang.Object

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

com.opengamma.strata.basics.index.ImmutableFxIndex.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<ImmutableFxIndex>

Enclosing class:

ImmutableFxIndex

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

The bean-builder for ImmutableFxIndex.

Method Summary

Modifier and Type	Method and Description
ImmutableFxIndex	build()
ImmutableFxIndex.Builder	currencyPair(CurrencyPair currencyPair) Sets the currency pair.
ImmutableFxIndex.Builder	fixingCalendar(HolidayCalendarId fixingCalendar) Sets the calendar that determines which dates are fixing dates.
ImmutableFxIndex.Builder	fixingDateOffset(DaysAdjustment fixingDateOffset) Sets the adjustment applied to the maturity date to obtain the fixing date.
Object	get(String propertyName)
ImmutableFxIndex.Builder	maturityDateOffset(DaysAdjustment maturityDateOffset) Sets the adjustment applied to the fixing date to obtain the maturity date.
ImmutableFxIndex.Builder	name(String name) Sets the index name, such as 'EUR/GBP-ECB'.
ImmutableFxIndex.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
ImmutableFxIndex.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<ImmutableFxIndex>

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public ImmutableFxIndex build()

name

public ImmutableFxIndex.Builder name(String name)

Sets the index name, such as 'EUR/GBP-ECB'.

Parameters:

name - the new value, not null

Returns:

this, for chaining, not null

currencyPair

public ImmutableFxIndex.Builder currencyPair(CurrencyPair currencyPair)

Sets the currency pair.

An index defines an FX rate in a single direction, such as from EUR to USD. This currency pair defines that direction.

In most cases, the same index can be used to convert in both directions by taking the rate or the reciprocal as necessary.

Parameters:

currencyPair - the new value, not null

Returns:

this, for chaining, not null

fixingCalendar

public ImmutableFxIndex.Builder fixingCalendar(HolidayCalendarId fixingCalendar)

Sets the calendar that determines which dates are fixing dates.

The fixing date is when the rate is determined.

Parameters:

fixingCalendar - the new value, not null

Returns:

this, for chaining, not null

fixingDateOffset

public ImmutableFxIndex.Builder fixingDateOffset(DaysAdjustment fixingDateOffset)

Sets the adjustment applied to the maturity date to obtain the fixing date.

The maturity date is the start date of the indexed deposit. In most cases, the fixing date is 2 days before the maturity date.

Parameters:

fixingDateOffset - the new value, not null

Returns:

this, for chaining, not null

maturityDateOffset

public ImmutableFxIndex.Builder maturityDateOffset(DaysAdjustment maturityDateOffset)

Sets the adjustment applied to the fixing date to obtain the maturity date.

The maturity date is the start date of the indexed deposit. In most cases, the maturity date is 2 days after the fixing date.

Parameters:

maturityDateOffset - 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<ImmutableFxIndex>