net.cnri.repository.util

Class FastDateFormat

java.lang.Object

net.cnri.repository.util.FastDateFormat

public class FastDateFormat
extends java.lang.Object

A thread-safe and high-performance class for formatting and parsing dates. FastDateFormat uses a proleptic Gregorian calendar with a zero year. Most ISO8601 date-times are parseable; fractional hours and minutes are not supported. A sensible subset of ISO8601 date-times can be produced by the format engine. Thread-safety is guaranteed; UTC-only methods are free-threaded; when a TimeZone is involved its calculation of DST offset is synchronized in formatting, and in parsing date representations without explicit time zone. Format methods referring to "Now" will automatically format System.currentTimeMillis() and will cache much of the calculation to increase performance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FastDateFormat.FormatSpec Specification of how to format a date.

Constructor Summary

Constructors

Constructor and Description
FastDateFormat(FastDateFormat.FormatSpec formatSpec, java.util.TimeZone zone) Constructs a FastDateFormat using the specified default format spec and the specified time zone, or UTC if given null.
FastDateFormat(java.util.TimeZone zone) Constructs a FastDateFormat using the specified time zone, or UTC if given null.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	format(FastDateFormat.FormatSpec formatSpec, long time) Formats a given time in a profile of ISO8601.
java.lang.String	format(FastDateFormat.FormatSpec formatSpec, long time, boolean isNow) Formats a given time in a profile of ISO8601.
static java.lang.String	format(FastDateFormat.FormatSpec formatSpec, long time, java.util.TimeZone zone) Formats a given time in a profile of ISO8601, using a specified time zone.
java.lang.String	format(long time) Formats a given time using the default format spec.
java.lang.String	format(long time, boolean isNow) Formats a given time using the default format spec.
static java.lang.String	format(long time, java.util.TimeZone zone) Formats a given time in the default format spec (2012-11-02T23:39:05.346-05:00), using a specified time zone.
java.lang.String	formatNow() Formats the current time using the default format spec, caching format calculations for increased performance over many calls.
java.lang.String	formatNow(FastDateFormat.FormatSpec formatSpec) Formats the current time in a profile of ISO8601, caching format calculations for increased performance over many calls.
static java.lang.String	formatUtc(FastDateFormat.FormatSpec formatSpec, long time) Formats a given time in a profile of ISO8601, using UTC.
static java.lang.String	formatUtc(long time) Formats a given time in the default format spec (2012-11-02T23:39:05.346Z), using UTC.
static FastDateFormat	getLocalFormat() Returns a FastDateFormat which uses the local time zone, TimeZone.getDefault().
static FastDateFormat	getUtcFormat() Returns a FastDateFormat which uses UTC.
static void	main(java.lang.String[] args)
long	parse(java.lang.String dateString) Parses a date representation which is generally ISO8601-compliant into milliseconds since the epoch.
static long	parse(java.lang.String dateString, java.util.TimeZone zone) Parses a date representation which is generally ISO8601-compliant into milliseconds since the epoch, using a given time zone if the time zone is not explicit in the input.
static long	parseUtc(java.lang.String dateString) Parses a date representation which is generally ISO8601-compliant into milliseconds since the epoch, assuming UTC if the time zone is not explicit in the input.

Methods inherited from class java.lang.Object

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

Constructor Detail

FastDateFormat

public FastDateFormat(java.util.TimeZone zone)

Constructs a FastDateFormat using the specified time zone, or UTC if given null. Default formatting is as FastDateFormat.FormatSpec.ISO8601_MS. For UTC and the default time zone, prefer getUtcFormat() and getLocalFormat().

Parameters:

zone - a TimeZone object, or null to use UTC.

FastDateFormat

public FastDateFormat(FastDateFormat.FormatSpec formatSpec,
              java.util.TimeZone zone)

Constructs a FastDateFormat using the specified default format spec and the specified time zone, or UTC if given null. For UTC and the default time zone, prefer getUtcFormat() and getLocalFormat().

Parameters:

formatSpec - a FastDateFormat.FormatSpec specifying the default formatting

zone - a TimeZone object, or null to use UTC.

Method Detail

formatNow

public java.lang.String formatNow()

Formats the current time using the default format spec, caching format calculations for increased performance over many calls.

format

public java.lang.String format(long time)

Formats a given time using the default format spec.

Parameters:

time - the time to format.

Returns:

format

public java.lang.String format(long time,
                      boolean isNow)

Formats a given time using the default format spec.

Parameters:

time - the time to format.

isNow - whether to cache formatting information over multiple calls. Should be set true when consecutive calls are close in time.

Returns:

formatNow

public java.lang.String formatNow(FastDateFormat.FormatSpec formatSpec)

Formats the current time in a profile of ISO8601, caching format calculations for increased performance over many calls.

Parameters:

formatSpec - specification of how to format.

Returns:

format

public java.lang.String format(FastDateFormat.FormatSpec formatSpec,
                      long time)

Formats a given time in a profile of ISO8601.

Parameters:

formatSpec - specification of how to format.

time - the time to format.

Returns:

format

public java.lang.String format(FastDateFormat.FormatSpec formatSpec,
                      long time,
                      boolean isNow)

Formats a given time in a profile of ISO8601.

Parameters:

formatSpec - specification of how to format.

time - the time to format.

isNow - whether to cache formatting information over multiple calls. Should be set true when consecutive calls are close in time.

Returns:

formatUtc

public static java.lang.String formatUtc(long time)

Formats a given time in the default format spec (2012-11-02T23:39:05.346Z), using UTC.

Parameters:

time - the time to format.

Returns:

format

public static java.lang.String format(long time,
                      java.util.TimeZone zone)

Formats a given time in the default format spec (2012-11-02T23:39:05.346-05:00), using a specified time zone.

Parameters:

time - the time to format.

zone - the time zone for the formatting.

Returns:

formatUtc

public static java.lang.String formatUtc(FastDateFormat.FormatSpec formatSpec,
                         long time)

Formats a given time in a profile of ISO8601, using UTC.

Parameters:

formatSpec - specification of how to format.

time - the time to format.

Returns:

format

public static java.lang.String format(FastDateFormat.FormatSpec formatSpec,
                      long time,
                      java.util.TimeZone zone)

Formats a given time in a profile of ISO8601, using a specified time zone.

Parameters:

formatSpec - specification of how to format.

time - the time to format.

zone - the time zone for the formatting.

Returns:

getUtcFormat

public static FastDateFormat getUtcFormat()

Returns a FastDateFormat which uses UTC.

getLocalFormat

public static FastDateFormat getLocalFormat()

Returns a FastDateFormat which uses the local time zone, TimeZone.getDefault().

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception

parse

public long parse(java.lang.String dateString)
           throws java.text.ParseException

Parses a date representation which is generally ISO8601-compliant into milliseconds since the epoch.

Parameters:

dateString - the date to be parsed.

Returns:

the date in milliseconds since 1970-01-01Z.

Throws:

java.text.ParseException - if the date can not be parsed.

parseUtc

public static long parseUtc(java.lang.String dateString)
                     throws java.text.ParseException

Parses a date representation which is generally ISO8601-compliant into milliseconds since the epoch, assuming UTC if the time zone is not explicit in the input.

Parameters:

dateString - the date to be parsed.

Returns:

the date in milliseconds since 1970-01-01Z.

Throws:

java.text.ParseException - if the date can not be parsed.

parse

public static long parse(java.lang.String dateString,
         java.util.TimeZone zone)
                  throws java.text.ParseException

Parses a date representation which is generally ISO8601-compliant into milliseconds since the epoch, using a given time zone if the time zone is not explicit in the input.

Parameters:

dateString - the date to be parsed.

zone - the time zone of the date if an explicit time zone is not given in the input.

Returns:

the date in milliseconds since 1970-01-01Z.

Throws:

java.text.ParseException - if the date can not be parsed.