com.esri.gpt.framework.util
Enum TimePeriod.Unit

java.lang.Object
  java.lang.Enum<TimePeriod.Unit>
      com.esri.gpt.framework.util.TimePeriod.Unit

All Implemented Interfaces:

Serializable, Comparable<TimePeriod.Unit>

Enclosing class:

TimePeriod

public static enum TimePeriod.Unit
extends Enum<TimePeriod.Unit>

Time unit.

Enum Constant Summary

day
day

hour
hour

millisecond
millisecond

minute
minute

month
month

second
second

week
week

Method Summary

static TimePeriod.Unit	checkValueOf(String value) Checks string value.
long	getMilliseconds() Gets milliseconds.
boolean	isToLocalizedStringeable()
boolean	isToStringeable()
static TimePeriod.Unit	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimePeriod.Unit[]	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 TimePeriod.Unit millisecond

millisecond

second

public static final TimePeriod.Unit second

second

minute

public static final TimePeriod.Unit minute

minute

hour

public static final TimePeriod.Unit hour

hour

day

public static final TimePeriod.Unit day

day

week

public static final TimePeriod.Unit week

week

month

public static final TimePeriod.Unit month

month

Method Detail

values

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

Returns:

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

valueOf

public static TimePeriod.Unit 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

checkValueOf

public static TimePeriod.Unit checkValueOf(String value)

Checks string value.

Parameters:

value - string representation of the value

Returns:

value represented by string or millisecond if value doesn't represent valid unit

getMilliseconds

public long getMilliseconds()

Gets milliseconds.

Returns:

number of milliseconds in one unit

isToStringeable

public boolean isToStringeable()

isToLocalizedStringeable

public boolean isToLocalizedStringeable()