org.jquantlib.time

Enum TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

org.jquantlib.time.TimeUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimeUnit>

public enum TimeUnit
extends java.lang.Enum<TimeUnit>

Time units

Enum Constant Summary

Enum Constants

Enum Constant and Description
Days
Months
Weeks
Years

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLongFormat() Returns the name of time unit in long format (e.g.
java.lang.String	getShortFormat() Returns the name of time unit in short format (e.g.
static TimeUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TimeUnit[]	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

Days

public static final TimeUnit Days

Weeks

public static final TimeUnit Weeks

Months

public static final TimeUnit Months

Years

public static final TimeUnit Years

Method Detail

values

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

Returns:

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

valueOf

public static TimeUnit valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getLongFormat

public java.lang.String getLongFormat()

Returns the name of time unit in long format (e.g. "week")

Returns:

the name of time unit in long format (e.g. "week")

getShortFormat

public java.lang.String getShortFormat()

Returns the name of time unit in short format (e.g. "w")

Returns:

the name of time unit in short format (e.g. "w")