biz.onixs.cme.stp.handler

Enum OriginalTimeUnit

java.lang.Object

java.lang.Enum<OriginalTimeUnit>

biz.onixs.cme.stp.handler.OriginalTimeUnit

All Implemented Interfaces:

Serializable, Comparable<OriginalTimeUnit>

public enum OriginalTimeUnit
extends Enum<OriginalTimeUnit>

Represents different time units that can be used as an original time reference.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Day Day.
Hour Hour.
Minute Minute.
Month Month.
None Default value.
Second Second.
Week Week.
Year Year.

Method Summary

Modifier and Type	Method and Description
static OriginalTimeUnit	forValue(String value) Returns enum value for the string representation
String	getValue() Gets current value.
static OriginalTimeUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static OriginalTimeUnit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final OriginalTimeUnit None

Default value. Do not use it directly.

Day

public static final OriginalTimeUnit Day

Day.

Hour

public static final OriginalTimeUnit Hour

Hour.

Minute

public static final OriginalTimeUnit Minute

Minute.

Month

public static final OriginalTimeUnit Month

Month.

Second

public static final OriginalTimeUnit Second

Second.

Week

public static final OriginalTimeUnit Week

Week.

Year

public static final OriginalTimeUnit Year

Year.

Method Detail

values

public static OriginalTimeUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OriginalTimeUnit c : OriginalTimeUnit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OriginalTimeUnit 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

getValue

public String getValue()

Gets current value.

Returns:

current value.

forValue

public static OriginalTimeUnit forValue(String value)

Returns enum value for the string representation

Parameters:

value - value

Returns:

value.