Package net.finmath.smartcontract.product.xml

Enum Class NonCashDividendTreatmentEnum

java.lang.Object

java.lang.Enum<NonCashDividendTreatmentEnum>

net.finmath.smartcontract.product.xml.NonCashDividendTreatmentEnum

All Implemented Interfaces:

Serializable, Comparable<NonCashDividendTreatmentEnum>, Constable

public enum NonCashDividendTreatmentEnum
extends Enum<NonCashDividendTreatmentEnum>

Java class for NonCashDividendTreatmentEnum.

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

 <simpleType name="NonCashDividendTreatmentEnum">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="PotentialAdjustmentEvent"/>
     <enumeration value="CashEquivalent"/>
   </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
CASH_EQUIVALENT	Any non-cash dividend shall be treated as a Declared Cash Equivalent Dividend.
POTENTIAL_ADJUSTMENT_EVENT	The treatment of any non-cash dividend shall be determined in accordance with the Potential Adjustment Event provisions.

Method Summary

Modifier and Type	Method	Description
static NonCashDividendTreatmentEnum	fromValue(String v)
String	value()
static NonCashDividendTreatmentEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static NonCashDividendTreatmentEnum[]	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

POTENTIAL_ADJUSTMENT_EVENT

public static final NonCashDividendTreatmentEnum POTENTIAL_ADJUSTMENT_EVENT

The treatment of any non-cash dividend shall be determined in accordance with the Potential Adjustment Event provisions.

CASH_EQUIVALENT

public static final NonCashDividendTreatmentEnum CASH_EQUIVALENT

Any non-cash dividend shall be treated as a Declared Cash Equivalent Dividend.

Method Details

values

public static NonCashDividendTreatmentEnum[] 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 NonCashDividendTreatmentEnum 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 NonCashDividendTreatmentEnum fromValue(String v)