org.forgerock.openam.utils

Class TimeUtils

java.lang.Object

org.forgerock.openam.utils.TimeUtils

public final class TimeUtils
extends Object

A collection of static immutable time functions. Note: Unix time (aka POSIX time or Epoch time), is a system for describing instants in time, defined as the number of seconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970, not counting leap seconds.

Field Summary

Fields

Modifier and Type	Field and Description
static TimeZone	UTC TimeZone for Universal Coordinated Time.

Method Summary

Modifier and Type	Method and Description
static long	currentUnixTime() Generates the current timestamp in Unix time format.
static Calendar	fromUnixTime(long unixTime) Converts Unix Time into Java Calendar time.
static Calendar	fromUnixTime(long unixTime, TimeUnit timeUnit) Converts Unix Time in the given time units into Java Calendar time.
static long	toUnixTime(Calendar timestamp) Convert from a Java Calendar instance into a Unix Time stamp.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UTC

public static final TimeZone UTC

TimeZone for Universal Coordinated Time.

Method Detail

toUnixTime

public static long toUnixTime(Calendar timestamp)

Convert from a Java Calendar instance into a Unix Time stamp. Java Calendar instances contain timezone information. This will be lost in the conversion and no attempt will be made to reconcile the local timezone with the timezone information in the Calendar.

Parameters:

timestamp - Non null timestamp to convert.

Returns:

A long representing the number of seconds from the epoch.

fromUnixTime

public static Calendar fromUnixTime(long unixTime)

Converts Unix Time into Java Calendar time. Unix Time is a measure of seconds from the epoch. Therefore is devoid of any timezone information. The current default timezone will be assumed for this function.

Parameters:

unixTime - A Unix timestamp.

Returns:

Non null Calendar representing this timestamp.

fromUnixTime

public static Calendar fromUnixTime(long unixTime,
                                    TimeUnit timeUnit)

Converts Unix Time in the given time units into Java Calendar time. Unix Time is a measure of time from the epoch. Therefore is devoid of any timezone information. The current default timezone will be assumed for this function.

Parameters:

unixTime - A Unix timestamp in the given time units.

timeUnit - The time units of the timestamp.

Returns:

Non null Calendar representing this timestamp.

currentUnixTime

public static long currentUnixTime()

Generates the current timestamp in Unix time format.

Returns:

A long representing seconds from the epoch.