Package org.silverpeas.core.date

Enum TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

org.silverpeas.core.date.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<TimeUnit>

public enum TimeUnit
extends Enum<TimeUnit>

An enumeration of time units to be used to express a well known defined unit in the time line.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAY	Time unit representing one day.
HOUR	Time unit representing one hour.
MILLISECOND	Time unit representing one millisecond.
MINUTE	Time unit representing one minute.
MONTH	Time unit representing one month.
SECOND	Time unit representing one second.
WEEK	Time unit representing one week.
YEAR	Time unit representing one year.

Method Summary

Modifier and Type	Method	Description
ChronoUnit	toChronoUnit()	Converts this time unit into a ChronoUnit value.
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

Time unit representing one millisecond.

SECOND

public static final TimeUnit SECOND

Time unit representing one second.

MINUTE

public static final TimeUnit MINUTE

Time unit representing one minute.

HOUR

public static final TimeUnit HOUR

Time unit representing one hour.

DAY

public static final TimeUnit DAY

Time unit representing one day.

WEEK

public static final TimeUnit WEEK

Time unit representing one week.

MONTH

public static final TimeUnit MONTH

Time unit representing one month.

YEAR

public static final TimeUnit YEAR

Time unit representing one 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

toChronoUnit

public ChronoUnit toChronoUnit()

Converts this time unit into a ChronoUnit value.

Returns:

a ChronoUnit instance matching this time unit.