com.opengamma.strata.product.option

Enum FutureOptionPremiumStyle

java.lang.Object

java.lang.Enum<FutureOptionPremiumStyle>

com.opengamma.strata.product.option.FutureOptionPremiumStyle

All Implemented Interfaces:

Named, NamedEnum, Serializable, Comparable<FutureOptionPremiumStyle>

public enum FutureOptionPremiumStyle
extends Enum<FutureOptionPremiumStyle>
implements NamedEnum

The style of premium for an option on a futures contract.

There are two styles of future options, one with daily margining, and one with an up-front premium. This class specifies the types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAILY_MARGIN The "DailyMargin" style, used where the option has daily margining.
UPFRONT_PREMIUM The "UpfrontPremium" style, used where the option has an upfront premium.

Method Summary

Modifier and Type	Method and Description
static FutureOptionPremiumStyle	of(String name) Obtains an instance from the specified name.
String	toString() Returns the formatted name of the type.
static FutureOptionPremiumStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static FutureOptionPremiumStyle[]	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

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

of

Enum Constant Detail

DAILY_MARGIN

public static final FutureOptionPremiumStyle DAILY_MARGIN

The "DailyMargin" style, used where the option has daily margining. This is also known as future-style margining.

UPFRONT_PREMIUM

public static final FutureOptionPremiumStyle UPFRONT_PREMIUM

The "UpfrontPremium" style, used where the option has an upfront premium. This is also known as equity-style margining.

Method Detail

values

public static FutureOptionPremiumStyle[] 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 (FutureOptionPremiumStyle c : FutureOptionPremiumStyle.values())
    System.out.println(c);

Returns:

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

valueOf

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

Returns:

the formatted string representing the type