com.yahoo.bard.webservice.web

Enum TimeMacro

java.lang.Object

java.lang.Enum<TimeMacro>

com.yahoo.bard.webservice.web.TimeMacro

All Implemented Interfaces:

Serializable, Comparable<TimeMacro>

public enum TimeMacro
extends Enum<TimeMacro>

TimeMacro.

Time macros are used as substitute for the actual date values

Enum Constant Summary

Enum Constants

Enum Constant and Description
CURRENT
NEXT

Method Summary

Modifier and Type	Method and Description
static TimeMacro	forName(String name) Get the time macro for the given name.
org.joda.time.DateTime	getDateTime(org.joda.time.DateTime dateTime, TimeGrain timeGrain) Calculate the macro-adjusted DateTime under the TimeGrain.
String	getName()
String	toString()
static TimeMacro	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimeMacro[]	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 Detail

CURRENT

public static final TimeMacro CURRENT

NEXT

public static final TimeMacro NEXT

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

toString

public String toString()

Overrides:

toString in class Enum<TimeMacro>

forName

public static TimeMacro forName(String name)

Get the time macro for the given name.

Parameters:

name - Name to find the time macro for

Returns:

the time macro that matches

getDateTime

public org.joda.time.DateTime getDateTime(org.joda.time.DateTime dateTime,
                                          TimeGrain timeGrain)

Calculate the macro-adjusted DateTime under the TimeGrain.

Parameters:

dateTime - DateTime to adjust

timeGrain - TimeGrain to adjust the DateTime for

Returns:

the macro-adjusted DateTime