com.opengamma.strata.basics.index

Class ImmutablePriceIndex.Builder

java.lang.Object

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

com.opengamma.strata.basics.index.ImmutablePriceIndex.Builder

All Implemented Interfaces:

org.joda.beans.BeanBuilder<ImmutablePriceIndex>

Enclosing class:

ImmutablePriceIndex

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

The bean-builder for ImmutablePriceIndex.

Method Summary

Modifier and Type	Method and Description
ImmutablePriceIndex.Builder	active(boolean active) Sets whether the index is active, defaulted to true.
ImmutablePriceIndex	build()
ImmutablePriceIndex.Builder	currency(Currency currency) Sets the currency of the index.
Object	get(String propertyName)
ImmutablePriceIndex.Builder	name(String name) Sets the index name, such as 'GB-HICP'.
ImmutablePriceIndex.Builder	publicationFrequency(Frequency publicationFrequency) Sets the publication frequency of the index.
ImmutablePriceIndex.Builder	region(Country region) Sets the region of the index.
ImmutablePriceIndex.Builder	set(org.joda.beans.MetaProperty<?> property, Object value)
ImmutablePriceIndex.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<ImmutablePriceIndex>

Overrides:

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

set

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

set

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

Specified by:

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

Overrides:

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

build

public ImmutablePriceIndex build()

name

public ImmutablePriceIndex.Builder name(String name)

Sets the index name, such as 'GB-HICP'.

Parameters:

name - the new value, not null

Returns:

this, for chaining, not null

region

public ImmutablePriceIndex.Builder region(Country region)

Sets the region of the index.

Parameters:

region - the new value, not null

Returns:

this, for chaining, not null

currency

public ImmutablePriceIndex.Builder currency(Currency currency)

Sets the currency of the index.

Parameters:

currency - the new value, not null

Returns:

this, for chaining, not null

active

public ImmutablePriceIndex.Builder active(boolean active)

Sets whether the index is active, defaulted to true.

Over time some indices become inactive and are no longer produced. If this occurs, this flag will be set to false.

Parameters:

active - the new value

Returns:

this, for chaining, not null

publicationFrequency

public ImmutablePriceIndex.Builder publicationFrequency(Frequency publicationFrequency)

Sets the publication frequency of the index. Most price indices are published monthly, but some are published quarterly.

Parameters:

publicationFrequency - 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<ImmutablePriceIndex>