com.opengamma.strata.basics.index

Class ImmutablePriceIndex

java.lang.Object

com.opengamma.strata.basics.index.ImmutablePriceIndex

All Implemented Interfaces:

FloatingRate, FloatingRateIndex, Index, PriceIndex, Named, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class ImmutablePriceIndex
extends Object
implements PriceIndex, org.joda.beans.ImmutableBean, Serializable

A price index implementation based on an immutable set of rules.

A standard immutable implementation of PriceIndex.

In most cases, applications should refer to indices by name, using PriceIndex.of(String). The named index will typically be resolved to an instance of this class. As such, it is recommended to use the PriceIndex interface in application code rather than directly referring to this class.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutablePriceIndex.Builder The bean-builder for ImmutablePriceIndex.
static class	ImmutablePriceIndex.Meta The meta-bean for ImmutablePriceIndex.

Method Summary

Modifier and Type	Method and Description
static ImmutablePriceIndex.Builder	builder() Returns a builder used to create an instance of the bean.
boolean	equals(Object obj)
Currency	getCurrency() Gets the currency of the index.
FloatingRateName	getFloatingRateName() Gets the floating rate name for this index.
String	getName() Gets the index name, such as 'GB-HICP'.
Frequency	getPublicationFrequency() Gets the publication frequency of the index.
Country	getRegion() Gets the region of the index.
int	hashCode()
boolean	isActive() Gets whether the index is active, defaulted to true.
static ImmutablePriceIndex.Meta	meta() The meta-bean for ImmutablePriceIndex.
ImmutablePriceIndex.Meta	metaBean()
ImmutablePriceIndex.Builder	toBuilder() Returns a builder that allows this bean to be mutated.
String	toString() Returns the name of the index.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.opengamma.strata.basics.index.PriceIndex

extendedEnum, getDayCount, of

Methods inherited from interface com.opengamma.strata.basics.index.FloatingRateIndex

getDefaultFixedLegDayCount, parse, parse, tryParse, tryParse

Methods inherited from interface com.opengamma.strata.collect.named.Named

of

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

getFloatingRateName

public FloatingRateName getFloatingRateName()

Description copied from interface: FloatingRateIndex

Gets the floating rate name for this index.

For an Ibor index, the FloatingRateName does not include the tenor. It can be used to find the other tenors available for this index.

Specified by:

getFloatingRateName in interface FloatingRate

Specified by:

getFloatingRateName in interface FloatingRateIndex

Returns:

the floating rate name

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns the name of the index.

Overrides:

toString in class Object

Returns:

the name of the index

meta

public static ImmutablePriceIndex.Meta meta()

The meta-bean for ImmutablePriceIndex.

Returns:

the meta-bean, not null

builder

public static ImmutablePriceIndex.Builder builder()

Returns a builder used to create an instance of the bean.

Returns:

the builder, not null

metaBean

public ImmutablePriceIndex.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getName

public String getName()

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

Specified by:

getName in interface FloatingRateIndex

Specified by:

getName in interface Index

Specified by:

getName in interface PriceIndex

Specified by:

getName in interface Named

Returns:

the value of the property, not null

getRegion

public Country getRegion()

Gets the region of the index.

Specified by:

getRegion in interface PriceIndex

Returns:

the value of the property, not null

getCurrency

public Currency getCurrency()

Gets the currency of the index.

Specified by:

getCurrency in interface FloatingRate

Specified by:

getCurrency in interface FloatingRateIndex

Returns:

the value of the property, not null

isActive

public boolean isActive()

Gets 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.

Specified by:

isActive in interface FloatingRateIndex

Returns:

the value of the property

getPublicationFrequency

public Frequency getPublicationFrequency()

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

Specified by:

getPublicationFrequency in interface PriceIndex

Returns:

the value of the property, not null

toBuilder

public ImmutablePriceIndex.Builder toBuilder()

Returns a builder that allows this bean to be mutated.

Returns:

the mutable builder, not null