com.silverpeas.scheduler.trigger
Enum TimeUnit

java.lang.Object
  java.lang.Enum<TimeUnit>
      com.silverpeas.scheduler.trigger.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<TimeUnit>

public enum TimeUnit
extends Enum<TimeUnit>

The unit of times as used and supported by the scheduling system in Silverpeas.

Enum Constant Summary

HOUR
The hour.

MINUTE
The minute.

SECOND
The second.

Method Summary

long	inMilliSeconds() How many milliseconds this unit of time is made.
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

SECOND

public static final TimeUnit SECOND

The second.

MINUTE

public static final TimeUnit MINUTE

The minute.

HOUR

public static final TimeUnit HOUR

The hour.

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

inMilliSeconds

public long inMilliSeconds()

How many milliseconds this unit of time is made.

Returns:

the conversion in milliseconds of this unit of time.