com.smartgwt.client.types
Enum TimeUnit

java.lang.Object
  extended by java.lang.Enum<TimeUnit>
      extended by com.smartgwt.client.types.TimeUnit
All Implemented Interfaces:
ValueEnum, Serializable, Comparable<TimeUnit>

public enum TimeUnit
extends Enum<TimeUnit>
implements ValueEnum

An enum of time-units available for use with the RelativeDateItem


Enum Constant Summary
DAY
          A day time-unit
HOUR
          An hour time-unit
MILLISECOND
          A millisecond time-unit
MINUTE
          A minute time-unit
MONTH
          A month time-unit
QUARTER
          A quarter (3-month) time-unit
SECOND
          A second time-unit
WEEK
          A week time-unit
YEAR
          A year time-unit
 
Method Summary
 String getValue()
           
static TimeUnit valueOf(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
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

MILLISECOND

public static final TimeUnit MILLISECOND
A millisecond time-unit


SECOND

public static final TimeUnit SECOND
A second time-unit


MINUTE

public static final TimeUnit MINUTE
A minute time-unit


HOUR

public static final TimeUnit HOUR
An hour time-unit


DAY

public static final TimeUnit DAY
A day time-unit


WEEK

public static final TimeUnit WEEK
A week time-unit


MONTH

public static final TimeUnit MONTH
A month time-unit


QUARTER

public static final TimeUnit QUARTER
A quarter (3-month) time-unit


YEAR

public static final TimeUnit YEAR
A year time-unit

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(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()
Specified by:
getValue in interface ValueEnum