com.opencloud.rhino.limiting

Enum TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

com.opencloud.rhino.limiting.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<TimeUnit>

public enum TimeUnit
extends Enum<TimeUnit>

An emumeration of time units, used when setting a limiter's rate. Note that the DAYS type indicates 24-hour periods rather than calendar days.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAYS
HOURS
MINUTES
SECONDS

Method Summary

Methods

Modifier and Type	Method and Description
int	getMillisecondsPerUnit()
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

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SECONDS

public static final TimeUnit SECONDS

MINUTES

public static final TimeUnit MINUTES

HOURS

public static final TimeUnit HOURS

DAYS

public static final TimeUnit DAYS

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

getMillisecondsPerUnit

public int getMillisecondsPerUnit()