Package com.primavera.common.value

Enum Class SpreadBucketType

java.lang.Object

java.lang.Enum<SpreadBucketType>

com.primavera.common.value.SpreadBucketType

All Implemented Interfaces:

Serializable, Comparable<SpreadBucketType>, java.lang.constant.Constable

public enum SpreadBucketType
extends Enum<SpreadBucketType>

SpreadBucketType defines the bucket types for which spreads are calculated and stored.

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
SBT_DAY
SBT_FINANCIAL_PERIOD
SBT_HOUR
SBT_MONTH
SBT_NONE
SBT_QUARTER
SBT_WEEK
SBT_YEAR

Method Summary

Modifier and Type	Method	Description
String	displayName()	Returns a Non-prefixed Display Name of the SpreadBucketType.
static SpreadBucketType	fromInt(int oldConstantVal)	Gets a SpreadBucketType instance based on the internal constant passed as an argument.
int	getMode()	Gets an internal mode value.
String	toString()	Returns a string representation of the object.
static SpreadBucketType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SpreadBucketType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SBT_NONE

public static final SpreadBucketType SBT_NONE

SBT_HOUR

public static final SpreadBucketType SBT_HOUR

SBT_DAY

public static final SpreadBucketType SBT_DAY

SBT_WEEK

public static final SpreadBucketType SBT_WEEK

SBT_MONTH

public static final SpreadBucketType SBT_MONTH

SBT_QUARTER

public static final SpreadBucketType SBT_QUARTER

SBT_YEAR

public static final SpreadBucketType SBT_YEAR

SBT_FINANCIAL_PERIOD

public static final SpreadBucketType SBT_FINANCIAL_PERIOD

Method Details

values

public static SpreadBucketType[] 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 SpreadBucketType 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

getMode

public int getMode()

Gets an internal mode value. This method should not be called from client code.

Returns:

an internal mode value

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Enum<SpreadBucketType>

Returns:

a string representation of the object

fromInt

public static SpreadBucketType fromInt(int oldConstantVal)

Gets a SpreadBucketType instance based on the internal constant passed as an argument.

Parameters:

oldConstantVal - the internal constant value

Returns:

SpreadBucketType the unique SpreadBucketType instance

displayName

public String displayName()

Returns a Non-prefixed Display Name of the SpreadBucketType. (E.g.: For SpreadBucketType.SBT_NONE, display name will be NONE, similarly For SpreadBucketType.SBT_YEAR, display name will be YEAR and so on)

Returns:

a display friendly string representation of the object.