org.silverpeas.util.time
Enum TimeUnit

java.lang.Object
  java.lang.Enum<TimeUnit>
      org.silverpeas.util.time.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<TimeUnit>

public enum TimeUnit
extends Enum<TimeUnit>

User: Yohann Chastagnier Date: 15/11/13

Enum Constant Summary

DAY

HOUR

MILLI

MIN

MONTH

SEC

WEEK

YEAR

Method Summary

protected String	getBundleDefault()
protected String	getBundleKey()
String	getLabel()
BigDecimal	getMultiplier(TimeUnit to)
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

MILLI

public static final TimeUnit MILLI

SEC

public static final TimeUnit SEC

MIN

public static final TimeUnit MIN

HOUR

public static final TimeUnit HOUR

DAY

public static final TimeUnit DAY

WEEK

public static final TimeUnit WEEK

MONTH

public static final TimeUnit MONTH

YEAR

public static final TimeUnit YEAR

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

getBundleKey

protected String getBundleKey()

getBundleDefault

protected String getBundleDefault()

getLabel

public String getLabel()

getMultiplier

public BigDecimal getMultiplier(TimeUnit to)