Package biz.onixs.cme.stp.handler

Enum FrequencyUnit

java.lang.Object

java.lang.Enum<FrequencyUnit>

biz.onixs.cme.stp.handler.FrequencyUnit

All Implemented Interfaces:

Serializable, Comparable<FrequencyUnit>

public enum FrequencyUnit
extends Enum<FrequencyUnit>

Source of alternate ID.

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method	Description
static FrequencyUnit	forValue(String value)	Returns enum value for the string representation
String	getValue()	Gets current value.
static FrequencyUnit	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FrequencyUnit[]	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 FrequencyUnit None

Default value. Do not use it directly.

Day

public static final FrequencyUnit Day

Day.

Hour

public static final FrequencyUnit Hour

Hour.

Minute

public static final FrequencyUnit Minute

Minute.

Month

public static final FrequencyUnit Month

Month.

Second

public static final FrequencyUnit Second

Second.

Week

public static final FrequencyUnit Week

Week.

Year

public static final FrequencyUnit Year

Year.

Term

public static final FrequencyUnit Term

Term.

Method Detail

values

public static FrequencyUnit[] 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 (FrequencyUnit c : FrequencyUnit.values())
    System.out.println(c);

Returns:

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

valueOf

public static FrequencyUnit 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 FrequencyUnit forValue(String value)

Returns enum value for the string representation

Parameters:

value - value

Returns:

value.