Package net.finmath.smartcontract.product.xml

Enum Class PayoutEnum

java.lang.Object

java.lang.Enum<PayoutEnum>

net.finmath.smartcontract.product.xml.PayoutEnum

All Implemented Interfaces:

Serializable, Comparable<PayoutEnum>, Constable

public enum PayoutEnum
extends Enum<PayoutEnum>

Java class for PayoutEnum.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="PayoutEnum">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="Deferred"/>
     <enumeration value="Immediate"/>
   </restriction>
 </simpleType>
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFERRED	If the trigger is hit, the option payout will not be paid now but will be paid on the value date of the original option.
IMMEDIATE	If the trigger is hit, the option payout will be paid immediately (i.e., spot from the payout date).

Method Summary

Modifier and Type	Method	Description
static PayoutEnum	fromValue(String v)
String	value()
static PayoutEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PayoutEnum[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DEFERRED

public static final PayoutEnum DEFERRED

If the trigger is hit, the option payout will not be paid now but will be paid on the value date of the original option.

IMMEDIATE

public static final PayoutEnum IMMEDIATE

If the trigger is hit, the option payout will be paid immediately (i.e., spot from the payout date).

Method Details

values

public static PayoutEnum[] values()

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

Returns:

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

valueOf

public static PayoutEnum valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

fromValue

public static PayoutEnum fromValue(String v)