Class FastDateFormat
- All Implemented Interfaces:
DatePrinter
FastDateFormat is a fast and thread-safe version of
SimpleDateFormat
.
To obtain an instance of FastDateFormat, use one of the static factory methods:
getInstance(String, TimeZone, Locale)
, getDateInstance(int, TimeZone, Locale)
,
getTimeInstance(int, TimeZone, Locale)
, or getDateTimeInstance(int, int, TimeZone, Locale)
Since FastDateFormat is thread safe, you can use a static member instance:
private static final FastDateFormat DATE_FORMATTER = FastDateFormat.getDateTimeInstance(FastDateFormat.LONG, FastDateFormat.SHORT);
This class can be used as a direct replacement to
SimpleDateFormat
in most formatting and parsing situations.
This class is especially useful in multi-threaded server environments.
SimpleDateFormat
is not thread-safe in any JDK version,
nor will it be as Sun have closed the bug/RFE.
All patterns are compatible with SimpleDateFormat (except time zones and some year patterns - see below).
Since 3.2, FastDateFormat supports parsing as well as printing.
Java 1.4 introduced a new pattern letter, 'Z'
, to represent
time zones in RFC822 format (eg. +0800
or -1100
).
This pattern letter can be used here (on all JDK versions).
In addition, the pattern 'ZZ'
has been made to represent
ISO 8601 extended format time zones (eg. +08:00
or -11:00
).
This introduces a minor incompatibility with Java 1.4, but at a gain of
useful functionality.
Javadoc cites for the year pattern: For formatting, if the number of pattern letters is 2, the year is truncated to 2 digits; otherwise it is interpreted as a number. Starting with Java 1.7 a pattern of 'Y' or 'YYY' will be formatted as '2003', while it was '03' in former Java versions. FastDateFormat implements the behavior of Java 7.
Copied and modified from Apache Commons Lang.
- Since:
- Apache Commons Lang 2.0
-
Field Summary
-
Constructor Summary
ModifierConstructorDescriptionprotected
FastDateFormat
(String pattern, TimeZone timeZone, Locale locale) Constructs a new FastDateFormat.protected
FastDateFormat
(String pattern, TimeZone timeZone, Locale locale, Date centuryStart) Constructs a new FastDateFormat. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Compares two objects for equality.format
(long millis) Formats a millisecondlong
value.<B extends Appendable>
Bformat
(long millis, B buf) Formats a millisecondlong
value into the suppliedStringBuffer
.format
(Object obj, StringBuilder toAppendTo, FieldPosition pos) Formats aDate
,Calendar
orLong
(milliseconds) object.Formats aCalendar
object.<B extends Appendable>
BFormats aCalendar
object into the suppliedStringBuffer
.Formats aDate
object using aGregorianCalendar
.<B extends Appendable>
BFormats aDate
object into the suppliedStringBuffer
using aGregorianCalendar
.static FastDateFormat
getDateInstance
(int style) Gets a date formatter instance using the specified style in the default time zone and locale.static FastDateFormat
getDateInstance
(int style, Locale locale) Gets a date formatter instance using the specified style and locale in the default time zone.static FastDateFormat
getDateInstance
(int style, TimeZone timeZone) Gets a date formatter instance using the specified style and time zone in the default locale.static FastDateFormat
getDateInstance
(int style, TimeZone timeZone, Locale locale) Gets a date formatter instance using the specified style, time zone and locale.static FastDateFormat
getDateTimeInstance
(int dateStyle, int timeStyle) Gets a date/time formatter instance using the specified style in the default time zone and locale.static FastDateFormat
getDateTimeInstance
(int dateStyle, int timeStyle, Locale locale) Gets a date/time formatter instance using the specified style and locale in the default time zone.static FastDateFormat
getDateTimeInstance
(int dateStyle, int timeStyle, TimeZone timeZone) Gets a date/time formatter instance using the specified style and time zone in the default locale.static FastDateFormat
getDateTimeInstance
(int dateStyle, int timeStyle, TimeZone timeZone, Locale locale) Gets a date/time formatter instance using the specified style, time zone and locale.static FastDateFormat
Gets a formatter instance using the default pattern in the default locale.static FastDateFormat
getInstance
(String pattern) Gets a formatter instance using the specified pattern in the default locale.static FastDateFormat
getInstance
(String pattern, Locale locale) Gets a formatter instance using the specified pattern and locale.static FastDateFormat
getInstance
(String pattern, TimeZone timeZone) Gets a formatter instance using the specified pattern and time zone.static FastDateFormat
getInstance
(String pattern, TimeZone timeZone, Locale locale) Gets a formatter instance using the specified pattern, time zone and locale.Gets the locale used by this formatter.int
Gets an estimate for the maximum string length that the formatter will produce.Gets the pattern used by this formatter.static FastDateFormat
getTimeInstance
(int style) Gets a time formatter instance using the specified style in the default time zone and locale.static FastDateFormat
getTimeInstance
(int style, Locale locale) Gets a time formatter instance using the specified style and locale in the default time zone.static FastDateFormat
getTimeInstance
(int style, TimeZone timeZone) Gets a time formatter instance using the specified style and time zone in the default locale.static FastDateFormat
getTimeInstance
(int style, TimeZone timeZone, Locale locale) Gets a time formatter instance using the specified style, time zone and locale.Gets the time zone used by this formatter.int
hashCode()
Returns a hash code compatible with equals.toString()
Gets a debugging string version of this formatter.
-
Field Details
-
FULL
public static final int FULLFULL locale dependent date or time style.- See Also:
-
LONG
public static final int LONGLONG locale dependent date or time style.- See Also:
-
MEDIUM
public static final int MEDIUMMEDIUM locale dependent date or time style.- See Also:
-
SHORT
public static final int SHORTSHORT locale dependent date or time style.- See Also:
-
-
Constructor Details
-
FastDateFormat
Constructs a new FastDateFormat.
- Parameters:
pattern
-SimpleDateFormat
compatible patterntimeZone
- non-null time zone to uselocale
- non-null locale to use- Throws:
NullPointerException
- if pattern, timeZone, or locale is null.
-
FastDateFormat
Constructs a new FastDateFormat.
- Parameters:
pattern
-SimpleDateFormat
compatible patterntimeZone
- non-null time zone to uselocale
- non-null locale to usecenturyStart
- The start of the 100 year period to use as the "default century" for 2 digit year parsing. If centuryStart is null, defaults to now - 80 years- Throws:
NullPointerException
- if pattern, timeZone, or locale is null.
-
-
Method Details
-
getInstance
Gets a formatter instance using the default pattern in the default locale.
- Returns:
- a date/time formatter
-
getInstance
Gets a formatter instance using the specified pattern in the default locale.
- Parameters:
pattern
-SimpleDateFormat
compatible pattern- Returns:
- a pattern based date/time formatter
- Throws:
IllegalArgumentException
- if pattern is invalid
-
getInstance
Gets a formatter instance using the specified pattern and time zone.
- Parameters:
pattern
-SimpleDateFormat
compatible patterntimeZone
- optional time zone, overrides time zone of formatted date- Returns:
- a pattern based date/time formatter
- Throws:
IllegalArgumentException
- if pattern is invalid
-
getInstance
Gets a formatter instance using the specified pattern and locale.
- Parameters:
pattern
-SimpleDateFormat
compatible patternlocale
- optional locale, overrides system locale- Returns:
- a pattern based date/time formatter
- Throws:
IllegalArgumentException
- if pattern is invalid
-
getInstance
Gets a formatter instance using the specified pattern, time zone and locale.
- Parameters:
pattern
-SimpleDateFormat
compatible patterntimeZone
- optional time zone, overrides time zone of formatted datelocale
- optional locale, overrides system locale- Returns:
- a pattern based date/time formatter
- Throws:
IllegalArgumentException
- if pattern is invalid ornull
-
getDateInstance
Gets a date formatter instance using the specified style in the default time zone and locale.
- Parameters:
style
- date style: FULL, LONG, MEDIUM, or SHORT- Returns:
- a localized standard date formatter
- Throws:
IllegalArgumentException
- if the Locale has no date pattern defined- Since:
- 2.1
-
getDateInstance
Gets a date formatter instance using the specified style and locale in the default time zone.
- Parameters:
style
- date style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system locale- Returns:
- a localized standard date formatter
- Throws:
IllegalArgumentException
- if the Locale has no date pattern defined- Since:
- 2.1
-
getDateInstance
Gets a date formatter instance using the specified style and time zone in the default locale.
- Parameters:
style
- date style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted date- Returns:
- a localized standard date formatter
- Throws:
IllegalArgumentException
- if the Locale has no date pattern defined- Since:
- 2.1
-
getDateInstance
Gets a date formatter instance using the specified style, time zone and locale.
- Parameters:
style
- date style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted datelocale
- optional locale, overrides system locale- Returns:
- a localized standard date formatter
- Throws:
IllegalArgumentException
- if the Locale has no date pattern defined
-
getTimeInstance
Gets a time formatter instance using the specified style in the default time zone and locale.
- Parameters:
style
- time style: FULL, LONG, MEDIUM, or SHORT- Returns:
- a localized standard time formatter
- Throws:
IllegalArgumentException
- if the Locale has no time pattern defined- Since:
- 2.1
-
getTimeInstance
Gets a time formatter instance using the specified style and locale in the default time zone.
- Parameters:
style
- time style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system locale- Returns:
- a localized standard time formatter
- Throws:
IllegalArgumentException
- if the Locale has no time pattern defined- Since:
- 2.1
-
getTimeInstance
Gets a time formatter instance using the specified style and time zone in the default locale.
- Parameters:
style
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted time- Returns:
- a localized standard time formatter
- Throws:
IllegalArgumentException
- if the Locale has no time pattern defined- Since:
- 2.1
-
getTimeInstance
Gets a time formatter instance using the specified style, time zone and locale.
- Parameters:
style
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted timelocale
- optional locale, overrides system locale- Returns:
- a localized standard time formatter
- Throws:
IllegalArgumentException
- if the Locale has no time pattern defined
-
getDateTimeInstance
Gets a date/time formatter instance using the specified style in the default time zone and locale.
- Parameters:
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORT- Returns:
- a localized standard date/time formatter
- Throws:
IllegalArgumentException
- if the Locale has no date/time pattern defined- Since:
- 2.1
-
getDateTimeInstance
Gets a date/time formatter instance using the specified style and locale in the default time zone.
- Parameters:
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system locale- Returns:
- a localized standard date/time formatter
- Throws:
IllegalArgumentException
- if the Locale has no date/time pattern defined- Since:
- 2.1
-
getDateTimeInstance
Gets a date/time formatter instance using the specified style and time zone in the default locale.
- Parameters:
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted date- Returns:
- a localized standard date/time formatter
- Throws:
IllegalArgumentException
- if the Locale has no date/time pattern defined- Since:
- 2.1
-
getDateTimeInstance
public static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle, TimeZone timeZone, Locale locale) Gets a date/time formatter instance using the specified style, time zone and locale.
- Parameters:
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted datelocale
- optional locale, overrides system locale- Returns:
- a localized standard date/time formatter
- Throws:
IllegalArgumentException
- if the Locale has no date/time pattern defined
-
format
Formats a
This method is an implementation ofDate
,Calendar
orLong
(milliseconds) object.Format.format(Object, StringBuilder, FieldPosition)
- Specified by:
format
in interfaceDatePrinter
- Specified by:
format
in classFormat
- Parameters:
obj
- the object to formattoAppendTo
- the buffer to append topos
- the position - ignored- Returns:
- the buffer passed in
- See Also:
-
format
Formats a millisecond
long
value.- Specified by:
format
in interfaceDatePrinter
- Parameters:
millis
- the millisecond value to format- Returns:
- the formatted string
- Since:
- 2.1
-
format
Formats a
Date
object using aGregorianCalendar
.- Specified by:
format
in interfaceDatePrinter
- Parameters:
date
- the date to format- Returns:
- the formatted string
-
format
Formats a
Calendar
object.- Specified by:
format
in interfaceDatePrinter
- Parameters:
calendar
- the calendar to format- Returns:
- the formatted string
-
format
Formats a millisecond
long
value into the suppliedStringBuffer
.- Specified by:
format
in interfaceDatePrinter
- Type Parameters:
B
- the Appendable class type, usually StringBuilder or StringBuffer.- Parameters:
millis
- the millisecond value to formatbuf
- the buffer to format into- Returns:
- the specified string buffer
- Since:
- 3.5
-
format
Formats a
Date
object into the suppliedStringBuffer
using aGregorianCalendar
.- Specified by:
format
in interfaceDatePrinter
- Type Parameters:
B
- the Appendable class type, usually StringBuilder or StringBuffer.- Parameters:
date
- the date to formatbuf
- the buffer to format into- Returns:
- the specified string buffer
- Since:
- 3.5
-
format
Formats a
Calendar
object into the suppliedStringBuffer
.- Specified by:
format
in interfaceDatePrinter
- Type Parameters:
B
- the Appendable class type, usually StringBuilder or StringBuffer.- Parameters:
calendar
- the calendar to formatbuf
- the buffer to format into- Returns:
- the specified string buffer
- Since:
- 3.5
-
getPattern
Gets the pattern used by this formatter.
- Specified by:
getPattern
in interfaceDatePrinter
- Returns:
- the pattern,
SimpleDateFormat
compatible
-
getTimeZone
Gets the time zone used by this formatter.
This zone is always used for
Date
formatting.- Specified by:
getTimeZone
in interfaceDatePrinter
- Returns:
- the time zone
-
getLocale
Gets the locale used by this formatter.
- Specified by:
getLocale
in interfaceDatePrinter
- Returns:
- the locale
-
getMaxLengthEstimate
public int getMaxLengthEstimate()Gets an estimate for the maximum string length that the formatter will produce.
The actual formatted length will almost always be less than or equal to this amount.
- Returns:
- the maximum formatted length
-
equals
Compares two objects for equality.
-
hashCode
public int hashCode()Returns a hash code compatible with equals.
-
toString
Gets a debugging string version of this formatter.
-