Package cdm.product.template

Enum OptionTypeEnum

java.lang.Object

java.lang.Enum<OptionTypeEnum>

cdm.product.template.OptionTypeEnum

All Implemented Interfaces:

Serializable, Comparable<OptionTypeEnum>

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

The enumerated values to specify the type of the option. In FpML, OptionTypeEnum is a union with PutCallEnum, which specifies whether the option is a put or a call.

Version:

5.30.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
CALL	A call option gives the holder the right to buy the underlying asset by a certain date for a certain price.
PAYER	A 'payer' option: If you buy a 'payer' option you have the right but not the obligation to enter into the underlying swap transaction as the 'fixed' rate/price payer and receive float.
PUT	A put option gives the holder the right to sell the underlying asset by a certain date for a certain price.
RECEIVER	A 'receiver' option: If you buy a 'receiver' option you have the right but not the obligation to enter into the underlying swap transaction as the 'fixed' rate/price receiver and pay float.
STRADDLE	A straddle strategy, which involves the simultaneous buying of a put and a call of the same underlier, at the same strike and same expiration date

Method Summary

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

PUT

@RosettaEnumValue("Put")
public static final OptionTypeEnum PUT

A put option gives the holder the right to sell the underlying asset by a certain date for a certain price.

CALL

@RosettaEnumValue("Call")
public static final OptionTypeEnum CALL

A call option gives the holder the right to buy the underlying asset by a certain date for a certain price.

PAYER

@RosettaEnumValue("Payer")
public static final OptionTypeEnum PAYER

A 'payer' option: If you buy a 'payer' option you have the right but not the obligation to enter into the underlying swap transaction as the 'fixed' rate/price payer and receive float.

RECEIVER

@RosettaEnumValue("Receiver")
public static final OptionTypeEnum RECEIVER

A 'receiver' option: If you buy a 'receiver' option you have the right but not the obligation to enter into the underlying swap transaction as the 'fixed' rate/price receiver and pay float.

STRADDLE

@RosettaEnumValue("Straddle")
public static final OptionTypeEnum STRADDLE

A straddle strategy, which involves the simultaneous buying of a put and a call of the same underlier, at the same strike and same expiration date

Method Details

values

public static OptionTypeEnum[] 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 OptionTypeEnum 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 OptionTypeEnum fromDisplayName(String name)

toString

public String toString()

Overrides:

toString in class Enum<OptionTypeEnum>

toDisplayString

public String toDisplayString()