Package com.opengamma.strata.market.model

Enum SabrParameterType

java.lang.Object

java.lang.Enum<SabrParameterType>

com.opengamma.strata.market.model.SabrParameterType

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<SabrParameterType>

public enum SabrParameterType
extends Enum<SabrParameterType>
implements NamedEnum

The type of the SABR parameter - Alpha, Beta, Rho, Nu or shift.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALPHA	SABR alpha.
BETA	SABR beta.
NU	SABR nu.
RHO	SABR rho.
SHIFT	SABR shift.

Method Summary

Modifier and Type	Method	Description
static SabrParameterType	of(String name)	Obtains an instance from the specified name.
String	toString()	Returns the formatted name of the type.
static SabrParameterType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SabrParameterType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getName

Enum Constant Detail

ALPHA

public static final SabrParameterType ALPHA

SABR alpha.

BETA

public static final SabrParameterType BETA

SABR beta.

RHO

public static final SabrParameterType RHO

SABR rho.

NU

public static final SabrParameterType NU

SABR nu.

SHIFT

public static final SabrParameterType SHIFT

SABR shift.

Method Detail

values

public static SabrParameterType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SabrParameterType c : SabrParameterType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SabrParameterType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

of

public static SabrParameterType of(String name)

Obtains an instance from the specified name.

Parsing handles the mixed case form produced by toString() and the upper and lower case variants of the enum constant name.

Parameters:

name - the name to parse

Returns:

the type

Throws:

IllegalArgumentException - if the name is not known

toString

public String toString()

Returns the formatted name of the type.

Overrides:

toString in class Enum<SabrParameterType>

Returns:

the formatted string representing the type