com.neeve.util

Class UtlTime

java.lang.Object

com.neeve.util.UtlTime

public final class UtlTime
extends Object

Utility class containing methods to work with time.

This class IS supported for use by end users.

Configuration

The following configuration properties are applicable to this class:

• UtlConstants.TIME_USENATIVE_PROPNAME
• UtlConstants.TIME_FORMAT_PROPNAME
• UtlConstants.TIME_TIMEZONEFORMAT_PROPNAME
• UtlConstants.TIME_FORMAT_PROPNAME

Constructor Summary

Constructors

Constructor and Description
UtlTime()

Method Summary

Modifier and Type	Method and Description
static void	cleanupFormatter() Cleans up the calling thread's ThreadLocal DateFormat
static String	format(Date date) Formats the given date using the current default timestamp format via a ThreadLocal DateFormat instance.
static DateFormat	getCachedTimestampFormatter() Get's the thread local cached, timestamp formatter with the current timestamp formatting settings.
static String	getTimestampFormat() Returns the current default timestamp format string
static DateFormat	getTimestampFormatter() Constructs a new DateFormat using the getTimestampFormat() and dateFormatTimeZone.
static TimeZone	getTimestampFormatTimeZone() Returns the current default timestamp format string
static boolean	isNativeTimeEnabled()
static void	main(String[] args) Prints the current time, suffixed with microseconds.
static long	now() Return the current time, in nanoseconds
static long	nowInMicros() Return the current time, in microseconds.
static long	nowInMillis() Return the current time, in millseconds.
static Date	parse(String timestamp) Attempts to parse the provide timestamp as a Date using the current timezone format.
static void	setTimestampFormat(String dateFormat) Sets the default timestamp format which is used by various platform components.
static TimeZone	setTimestampFormatTimeZone(String timezone) Sets the default date format timezone which is used by various platform components Note, that this will not affect components that have already retrieved the a dateformat unless those components resample the timezoneFormat This method looks up the timezone using TimeZone.getTimeZone(String) which will default the timezone to 'GMT' if the given timezone is not valid.
static void	setTimestampFormatTimeZone(TimeZone timezone) Sets the default date format timezone which is used by various platform components Note, that this will not affect components that have already retrieved the a dateformat unless those components resample the timezoneFormat

Methods inherited from class java.lang.Object

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

Constructor Detail

UtlTime

public UtlTime()

Method Detail

isNativeTimeEnabled

public static final boolean isNativeTimeEnabled()

Returns:

true if native time is enabled.

now

public static final long now()

Return the current time, in nanoseconds

Returns:

the difference, measured in nanoseconds, between the current time and midnight, January 1, 1970 UTC.

nowInMicros

public static final long nowInMicros()

Return the current time, in microseconds.

Returns:

the difference, measured in microseconds, between the current time and midnight, January 1, 1970 UTC.

nowInMillis

public static final long nowInMillis()

Return the current time, in millseconds.

Returns:

the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.

setTimestampFormat

public static final void setTimestampFormat(String dateFormat)

Sets the default timestamp format which is used by various platform components. The timestamp format is intended to include both date and time. This timestamp format is intended for use in human readable strings and would not be used in places that have an impact on encoding.

Parameters:

dateFormat - The date format to be used by getTimestampFormatter()

Throws:

IllegalArgumentException - if the dateFormat is not valid

getTimestampFormat

public static final String getTimestampFormat()

Returns the current default timestamp format string

Returns:

the current default timestamp format string

setTimestampFormatTimeZone

public static final void setTimestampFormatTimeZone(TimeZone timezone)

Sets the default date format timezone which is used by various platform components Note, that this will not affect components that have already retrieved the a dateformat unless those components resample the timezoneFormat

Parameters:

timezone - The time zone to be used by getTimestampFormat()

setTimestampFormatTimeZone

public static final TimeZone setTimestampFormatTimeZone(String timezone)

Sets the default date format timezone which is used by various platform components Note, that this will not affect components that have already retrieved the a dateformat unless those components resample the timezoneFormat

This method looks up the timezone using TimeZone.getTimeZone(String) which will default the timezone to 'GMT' if the given timezone is not valid.

Parameters:

timezone - The time zone to be used by getTimestampFormatter()

Returns:

the TimeZone that was set.

getTimestampFormatTimeZone

public static final TimeZone getTimestampFormatTimeZone()

Returns the current default timestamp format string

Returns:

the current default timestamp format string

getTimestampFormatter

public static final DateFormat getTimestampFormatter()

Constructs a new DateFormat using the getTimestampFormat() and dateFormatTimeZone.

Returns:

A new DateFormat.

format

public static final String format(Date date)

Formats the given date using the current default timestamp format via a ThreadLocal DateFormat instance. Callers of this mehod should call cleanupFormatter() before the the calling thread is stopped.

Parameters:

date - The date to format.

Returns:

The date formatted as a timestamp.

parse

public static final Date parse(String timestamp)
                        throws ParseException

Attempts to parse the provide timestamp as a Date using the current timezone format.

Parameters:

timestamp - The timestamp to parse

Returns:

The parsed date

Throws:

ParseException - if there is an error parsing the timestamp

getCachedTimestampFormatter

public static final DateFormat getCachedTimestampFormatter()

Get's the thread local cached, timestamp formatter with the current timestamp formatting settings.

Returns:

The current timestamp format for the calling thread.

cleanupFormatter

public static final void cleanupFormatter()

Cleans up the calling thread's ThreadLocal DateFormat

main

public static final void main(String[] args)

Prints the current time, suffixed with microseconds.

Parameters:

args - Argumens (unused).