Enum Class CorporateEvents.DividendKind

java.lang.Object

java.lang.Enum<CorporateEvents.DividendKind>

com.quantfinlib.data.CorporateEvents.DividendKind

All Implemented Interfaces:

Serializable, Comparable<CorporateEvents.DividendKind>, Constable

Enclosing class:

CorporateEvents

public static enum CorporateEvents.DividendKind
extends Enum<CorporateEvents.DividendKind>

Regular or special cash dividend.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
REGULAR
SPECIAL

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REGULAR

public static final CorporateEvents.DividendKind REGULAR

SPECIAL

public static final CorporateEvents.DividendKind SPECIAL

Method Details

values

public static CorporateEvents.DividendKind[] 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 CorporateEvents.DividendKind 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