org.forgerock.openam.utils

Enum Time

java.lang.Object

java.lang.Enum<Time>

org.forgerock.openam.utils.Time

All Implemented Interfaces:

Serializable, Comparable<Time>, org.joda.time.DateTimeUtils.MillisProvider

public enum Time
extends Enum<Time>
implements org.joda.time.DateTimeUtils.MillisProvider

The source of all time-based information in OpenAM.

Use the methods on this class where you would have otherwise used System.currentTimeMillis(), new Date(), Calendar.getInstance() or the various constructors and now methods in org.joda.time.DateTime.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton Instance.

Method Summary

Modifier and Type	Method and Description
static long	currentTimeMillis() Get the current time in milliseconds from the TimeService - this replaces System.currentTimeMillis().
static Calendar	getCalendarInstance() Get a Calendar with current time in milliseconds from the TimeService - this replaces Calendar.getInstance().
static Calendar	getCalendarInstance(Locale locale) Get a Calendar with current time in milliseconds from the TimeService - this replaces Calendar.getInstance(Locale).
static Calendar	getCalendarInstance(TimeZone tz) Get a Calendar with current time in milliseconds from the TimeService - this replaces Calendar.getInstance(TimeZone).
static Calendar	getCalendarInstance(TimeZone tz, Locale locale) Get a Calendar with current time in milliseconds from the TimeService - this replaces Calendar.getInstance(TimeZone, Locale).
long	getMillis()
static Date	newDate() Get a Date with current time in milliseconds from the TimeService - this replaces new Date().
static Date	newDate(long time) Get a Date with the specified time in milliseconds - this replaces new Date(long).
static Time	valueOf(String name) Returns the enum constant of this type with the specified name.
static Time[]	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

INSTANCE

public static final Time INSTANCE

Singleton Instance.

Method Detail

values

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

Returns:

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

valueOf

public static Time 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

getMillis

public long getMillis()

Specified by:

getMillis in interface org.joda.time.DateTimeUtils.MillisProvider

currentTimeMillis

public static long currentTimeMillis()

Get the current time in milliseconds from the TimeService - this replaces System.currentTimeMillis().

Returns:

The current time since the epoch in milliseconds.

See Also:

System.currentTimeMillis()

newDate

public static Date newDate()

Get a Date with current time in milliseconds from the TimeService - this replaces new Date().

Returns:

A date with the current time since the epoch in milliseconds.

See Also:

Date()

newDate

public static Date newDate(long time)

Get a Date with the specified time in milliseconds - this replaces new Date(long).

Parameters:

time - The time in milliseconds.

Returns:

A date with the time since the epoch in milliseconds.

See Also:

Date()

getCalendarInstance

public static Calendar getCalendarInstance()

Get a Calendar with current time in milliseconds from the TimeService - this replaces Calendar.getInstance().

Returns:

A date with the current time since the epoch in milliseconds.

See Also:

Calendar.getInstance()

getCalendarInstance

public static Calendar getCalendarInstance(Locale locale)

Get a Calendar with current time in milliseconds from the TimeService - this replaces Calendar.getInstance(Locale).

Parameters:

locale - The locale to use for the calendar instance.

Returns:

A date with the current time since the epoch in milliseconds.

See Also:

Calendar.getInstance(Locale)

getCalendarInstance

public static Calendar getCalendarInstance(TimeZone tz)

Get a Calendar with current time in milliseconds from the TimeService - this replaces Calendar.getInstance(TimeZone).

Parameters:

tz - The timezone to use for the calendar instance.

Returns:

A date with the current time since the epoch in milliseconds.

See Also:

Calendar.getInstance(TimeZone)

getCalendarInstance

public static Calendar getCalendarInstance(TimeZone tz,
                                           Locale locale)

Get a Calendar with current time in milliseconds from the TimeService - this replaces Calendar.getInstance(TimeZone, Locale).

Parameters:

tz - The timezone to use for the calendar instance.

locale - The locale to use for the calendar instance.

Returns:

A date with the current time since the epoch in milliseconds.

See Also:

Calendar.getInstance(TimeZone, Locale)