com.opengamma.strata.calc

Class ImmutableMeasure

java.lang.Object

com.opengamma.strata.calc.ImmutableMeasure

All Implemented Interfaces:

Measure, Named, Serializable, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class ImmutableMeasure
extends Object
implements Measure, org.joda.beans.ImmutableBean, Serializable

The default, immutable implementation of Measure.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableMeasure.Meta The meta-bean for ImmutableMeasure.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getName() Gets the measure name.
int	hashCode()
boolean	isCurrencyConvertible() Gets flag indicating whether measure values should be automatically converted to the reporting currency.
static ImmutableMeasure.Meta	meta() The meta-bean for ImmutableMeasure.
ImmutableMeasure.Meta	metaBean()
static ImmutableMeasure	of(String name) Returns a measure with the specified name whose values will be automatically converted to the reporting currency.
static ImmutableMeasure	of(String name, boolean isCurrencyConvertible) Returns a measure with the specified name.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opengamma.strata.calc.Measure

extendedEnum

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

of

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

of

public static ImmutableMeasure of(String name)

Returns a measure with the specified name whose values will be automatically converted to the reporting currency.

Measure names must only contains the characters A-Z, a-z, 0-9 and -.

Specified by:

of in interface Measure

Parameters:

name - the measure name

Returns:

a measure with the specified name

of

public static ImmutableMeasure of(String name,
                                  boolean isCurrencyConvertible)

Returns a measure with the specified name.

Measure names must only contains the characters A-Z, a-z, 0-9 and -.

Parameters:

name - the measure name

isCurrencyConvertible - flag indicating whether measure values should be automatically converted to the reporting currency.

Returns:

a measure with the specified name

toString

public String toString()

Overrides:

toString in class Object

meta

public static ImmutableMeasure.Meta meta()

The meta-bean for ImmutableMeasure.

Returns:

the meta-bean, not null

metaBean

public ImmutableMeasure.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getName

public String getName()

Gets the measure name.

Measure names must only contains the characters A-Z, a-z, 0-9 and -.

Specified by:

getName in interface Measure

Specified by:

getName in interface Named

Returns:

the value of the property, not null

isCurrencyConvertible

public boolean isCurrencyConvertible()

Gets flag indicating whether measure values should be automatically converted to the reporting currency.

Specified by:

isCurrencyConvertible in interface Measure

Returns:

the value of the property

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object