Package cdm.product.asset

Enum ReturnTypeEnum

java.lang.Object

java.lang.Enum<ReturnTypeEnum>

cdm.product.asset.ReturnTypeEnum

All Implemented Interfaces:

Serializable, Comparable<ReturnTypeEnum>

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

The enumerated values to specify the type of return associated the equity payout.

Version:

5.30.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
PRICE	Price return, i.e. excluding dividends.
TOTAL	Total return, i.e. including dividend and price components.

Method Summary

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

PRICE

@RosettaEnumValue("Price")
public static final ReturnTypeEnum PRICE

Price return, i.e. excluding dividends.

TOTAL

@RosettaEnumValue("Total")
public static final ReturnTypeEnum TOTAL

Total return, i.e. including dividend and price components.

Method Details

values

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

toString

public String toString()

Overrides:

toString in class Enum<ReturnTypeEnum>

toDisplayString

public String toDisplayString()