Enum Class CorporateEvents.DividendPolicy

java.lang.Object

java.lang.Enum<CorporateEvents.DividendPolicy>

com.quantfinlib.data.CorporateEvents.DividendPolicy

All Implemented Interfaces:

Serializable, Comparable<CorporateEvents.DividendPolicy>, Constable

Enclosing class:

CorporateEvents

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

Which dividends enter the back-adjustment.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Regular and special dividends both adjust (CRSP-style total return).
NONE	No dividend adjusts (price-return series).
SPECIAL_ONLY	Only special dividends adjust; regular ones stay in the price series.

Method Summary

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

ALL

public static final CorporateEvents.DividendPolicy ALL

Regular and special dividends both adjust (CRSP-style total return).

SPECIAL_ONLY

public static final CorporateEvents.DividendPolicy SPECIAL_ONLY

Only special dividends adjust; regular ones stay in the price series.

NONE

public static final CorporateEvents.DividendPolicy NONE

No dividend adjusts (price-return series).

Method Details

values

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