com.opengamma.strata.basics.index

Interface Index

All Superinterfaces:

Named

All Known Subinterfaces:

FloatingRateIndex, FxIndex, IborIndex, OvernightIndex, PriceIndex, RateIndex

All Known Implementing Classes:

ImmutableFxIndex, ImmutableIborIndex, ImmutableOvernightIndex, ImmutablePriceIndex

public interface Index
extends Named

An index of values, such as LIBOR, FED FUND or daily exchange rates.

An index is an agreed mechanism for determining certain financial indicators, such as exchange rate or interest rates. Most common indices are daily.

This is a marker interface, see FxIndex, IborIndex and OvernightIndex for more information.

All implementations of this interface must be immutable and thread-safe.

Method Summary

Modifier and Type	Method and Description
String	getName() Gets the name that uniquely identifies this index.
static Index	of(String uniqueName) Obtains an instance from the specified unique name.

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

of

Method Detail

of

static Index of(String uniqueName)

Obtains an instance from the specified unique name.

Parameters:

uniqueName - the unique name

Returns:

the index

Throws:

IllegalArgumentException - if the name is not known

getName

String getName()

Gets the name that uniquely identifies this index.

This name is used in serialization and can be parsed using of(String).

Specified by:

getName in interface Named

Returns:

the unique name