Package cdm.product.asset

Enum FinalPrincipalExchangeCalculationEnum

java.lang.Object

java.lang.Enum<FinalPrincipalExchangeCalculationEnum>

cdm.product.asset.FinalPrincipalExchangeCalculationEnum

All Implemented Interfaces:

Serializable, Comparable<FinalPrincipalExchangeCalculationEnum>

@RosettaEnum("FinalPrincipalExchangeCalculationEnum")
public enum FinalPrincipalExchangeCalculationEnum
extends Enum<FinalPrincipalExchangeCalculationEnum>

To be specified only for products that embed a redemption payment.

Version:

5.30.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
FLOORED	If Floored is set then Principal Exchange takes the form: Notional Amount * Max(1, Index Final/ Index Base).
NON_FLOORED	If NonFloored is set then the Principal Exchange takes the form: Notional Amount * Index Final / Index Base.

Method Summary

Modifier and Type	Method	Description
static FinalPrincipalExchangeCalculationEnum	fromDisplayName(String name)
String	toDisplayString()
String	toString()
static FinalPrincipalExchangeCalculationEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FinalPrincipalExchangeCalculationEnum[]	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

Enum Constant Details

FLOORED

@RosettaEnumValue("Floored")
public static final FinalPrincipalExchangeCalculationEnum FLOORED

If Floored is set then Principal Exchange takes the form: Notional Amount * Max(1, Index Final/ Index Base).

NON_FLOORED

@RosettaEnumValue("NonFloored")
public static final FinalPrincipalExchangeCalculationEnum NON_FLOORED

If NonFloored is set then the Principal Exchange takes the form: Notional Amount * Index Final / Index Base.

Method Details

values

public static FinalPrincipalExchangeCalculationEnum[] values()

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

Returns:

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

valueOf

public static FinalPrincipalExchangeCalculationEnum 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

fromDisplayName

public static FinalPrincipalExchangeCalculationEnum fromDisplayName(String name)

toString

public String toString()

Overrides:

toString in class Enum<FinalPrincipalExchangeCalculationEnum>

toDisplayString

public String toDisplayString()