Package net.finmath.smartcontract.product.xml

Enum Class DividendCompositionEnum

java.lang.Object

java.lang.Enum<DividendCompositionEnum>

net.finmath.smartcontract.product.xml.DividendCompositionEnum

All Implemented Interfaces:

Serializable, Comparable<DividendCompositionEnum>, Constable

public enum DividendCompositionEnum
extends Enum<DividendCompositionEnum>

Java class for DividendCompositionEnum.

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

 <simpleType name="DividendCompositionEnum">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="EquityAmountReceiverElection"/>
     <enumeration value="CalculationAgentElection"/>
   </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
CALCULATION_AGENT_ELECTION	The Calculation Agent determines the composition of dividends (subject to conditions).
EQUITY_AMOUNT_RECEIVER_ELECTION	The Equity Amount Receiver determines the composition of dividends (subject to conditions).

Method Summary

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

EQUITY_AMOUNT_RECEIVER_ELECTION

public static final DividendCompositionEnum EQUITY_AMOUNT_RECEIVER_ELECTION

The Equity Amount Receiver determines the composition of dividends (subject to conditions).

CALCULATION_AGENT_ELECTION

public static final DividendCompositionEnum CALCULATION_AGENT_ELECTION

The Calculation Agent determines the composition of dividends (subject to conditions).

Method Details

values

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