Package cdm.base.datetime

Enum PeriodExtendedEnum

java.lang.Object

java.lang.Enum<PeriodExtendedEnum>

cdm.base.datetime.PeriodExtendedEnum

All Implemented Interfaces:

Serializable, Comparable<PeriodExtendedEnum>

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

The enumerated values to specify a time period containing the additional value of Term.

Version:

5.30.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
C	CalculationPeriod - the period corresponds to the calculation period For example, used in the Commodity Markets to indicate that a reference contract is the one that corresponds to the period of the calculation period.
D	Day
H	Hour
M	Month
T	Term.
W	Week
Y	Year

Method Summary

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

H

@RosettaEnumValue("H")
public static final PeriodExtendedEnum H

Hour

D

@RosettaEnumValue("D")
public static final PeriodExtendedEnum D

Day

W

@RosettaEnumValue("W")
public static final PeriodExtendedEnum W

Week

M

@RosettaEnumValue("M")
public static final PeriodExtendedEnum M

Month

Y

@RosettaEnumValue("Y")
public static final PeriodExtendedEnum Y

Year

T

@RosettaEnumValue("T")
public static final PeriodExtendedEnum T

Term. The period commencing on the effective date and ending on the termination date. The T period always appears in association with periodMultiplier = 1, and the notation is intended for use in contexts where the interval thus qualified (e.g. accrual period, payment period, reset period, ...) spans the entire term of the trade.

C

@RosettaEnumValue("C")
public static final PeriodExtendedEnum C

CalculationPeriod - the period corresponds to the calculation period For example, used in the Commodity Markets to indicate that a reference contract is the one that corresponds to the period of the calculation period.

Method Details

values

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

toString

public String toString()

Overrides:

toString in class Enum<PeriodExtendedEnum>

toDisplayString

public String toDisplayString()