Class FastDateFormat
- All Implemented Interfaces:
Serializable
,Cloneable
FastDateFormat is a fast and thread-safe version of
SimpleDateFormat
.
This class can be used as a direct replacement to
SimpleDateFormat
in most formatting 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.
Only formatting is supported, but all patterns are compatible with SimpleDateFormat (except time zones - see below).
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
ISO8601 full 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.
- Since:
- 2.0
- Version:
- $Id: FastDateFormat.java 1057072 2011-01-10 01:55:57Z niallp $
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.text.Format
Format.Field
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
FastDateFormat
(String pattern, TimeZone timeZone, Locale locale) Constructs a new FastDateFormat. -
Method Summary
Modifier and TypeMethodDescriptionprotected StringBuffer
applyRules
(Calendar calendar, StringBuffer buf) Performs the formatting by applying the rules to the specified calendar.boolean
Compares two objects for equality.format
(long millis) Formats a millisecondlong
value.format
(long millis, StringBuffer buf) Formats a milliseondlong
value into the suppliedStringBuffer
.format
(Object obj, StringBuffer toAppendTo, FieldPosition pos) Formats aDate
,Calendar
orLong
(milliseconds) object.Formats aCalendar
object.format
(Calendar calendar, StringBuffer buf) Formats aCalendar
object into the suppliedStringBuffer
.Formats aDate
object.format
(Date date, StringBuffer buf) Formats aDate
object into the suppliedStringBuffer
.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.boolean
Returnstrue
if the time zone of the calendar overrides the time zone of the formatter.int
hashCode()
Returns a hashcode compatible with equals.protected void
init()
Initializes the instance for first use.parseObject
(String source, ParsePosition pos) Parsing is not supported.protected List
Returns a list of Rules given a pattern.protected String
parseToken
(String pattern, int[] indexRef) Performs the parsing of tokens.protected org.apache.commons.lang.time.FastDateFormat.NumberRule
selectNumberRule
(int field, int padding) Gets an appropriate rule for the padding required.toString()
Gets a debugging string version of this formatter.Methods inherited from class java.text.Format
clone, format, formatToCharacterIterator, parseObject
-
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
- time zone to use,null
means use default forDate
and value within forCalendar
locale
- locale,null
means use system default- Throws:
IllegalArgumentException
- if pattern is invalid ornull
-
-
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
-
init
protected void init()Initializes the instance for first use.
-
parsePattern
Returns a list of Rules given a pattern.
- Returns:
- a
List
of Rule objects - Throws:
IllegalArgumentException
- if pattern is invalid
-
parseToken
Performs the parsing of tokens.
- Parameters:
pattern
- the patternindexRef
- index references- Returns:
- parsed token
-
selectNumberRule
protected org.apache.commons.lang.time.FastDateFormat.NumberRule selectNumberRule(int field, int padding) Gets an appropriate rule for the padding required.
- Parameters:
field
- the field to get a rule forpadding
- the padding required- Returns:
- a new rule with the correct padding
-
format
Formats a
Date
,Calendar
orLong
(milliseconds) object. -
format
Formats a millisecond
long
value.- Parameters:
millis
- the millisecond value to format- Returns:
- the formatted string
- Since:
- 2.1
-
format
Formats a
Date
object.- Parameters:
date
- the date to format- Returns:
- the formatted string
-
format
Formats a
Calendar
object.- Parameters:
calendar
- the calendar to format- Returns:
- the formatted string
-
format
Formats a milliseond
long
value into the suppliedStringBuffer
.- Parameters:
millis
- the millisecond value to formatbuf
- the buffer to format into- Returns:
- the specified string buffer
- Since:
- 2.1
-
format
Formats a
Date
object into the suppliedStringBuffer
.- Parameters:
date
- the date to formatbuf
- the buffer to format into- Returns:
- the specified string buffer
-
format
Formats a
Calendar
object into the suppliedStringBuffer
.- Parameters:
calendar
- the calendar to formatbuf
- the buffer to format into- Returns:
- the specified string buffer
-
applyRules
Performs the formatting by applying the rules to the specified calendar.
- Parameters:
calendar
- the calendar to formatbuf
- the buffer to format into- Returns:
- the specified string buffer
-
parseObject
Parsing is not supported.
- Specified by:
parseObject
in classFormat
- Parameters:
source
- the string to parsepos
- the parsing position- Returns:
null
as not supported
-
getPattern
Gets the pattern used by this formatter.
- Returns:
- the pattern,
SimpleDateFormat
compatible
-
getTimeZone
Gets the time zone used by this formatter.
This zone is always used for
Date
formatting. If aCalendar
is passed in to be formatted, the time zone on that may be used depending ongetTimeZoneOverridesCalendar()
.- Returns:
- the time zone
-
getTimeZoneOverridesCalendar
public boolean getTimeZoneOverridesCalendar()Returns
true
if the time zone of the calendar overrides the time zone of the formatter.- Returns:
true
if time zone of formatter overridden for calendars
-
getLocale
Gets the locale used by this formatter.
- 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 hashcode compatible with equals.
-
toString
Gets a debugging string version of this formatter.
-