public class FastDateFormat extends java.text.Format implements DateParser, 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.
Modifier and Type | Field and Description |
---|---|
static int |
FULL
FULL locale dependent date or time style.
|
static int |
LONG
LONG locale dependent date or time style.
|
static int |
MEDIUM
MEDIUM locale dependent date or time style.
|
static int |
SHORT
SHORT locale dependent date or time style.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj)
Compares two objects for equality.
|
java.lang.String |
format(java.util.Calendar calendar)
Formats a
Calendar object. |
<B extends java.lang.Appendable> |
format(java.util.Calendar calendar,
B buf)
Formats a
Calendar object into the
supplied StringBuffer . |
java.lang.StringBuffer |
format(java.util.Calendar calendar,
java.lang.StringBuffer buf)
Deprecated.
|
java.lang.String |
format(java.util.Date date)
Formats a
Date object using a GregorianCalendar . |
<B extends java.lang.Appendable> |
format(java.util.Date date,
B buf)
Formats a
Date object into the
supplied StringBuffer using a GregorianCalendar . |
java.lang.StringBuffer |
format(java.util.Date date,
java.lang.StringBuffer buf)
Deprecated.
Use {
format(Date, Appendable) . |
java.lang.String |
format(long millis)
Formats a millisecond
long value. |
<B extends java.lang.Appendable> |
format(long millis,
B buf)
Formats a millisecond
long value into the
supplied StringBuffer . |
java.lang.StringBuffer |
format(long millis,
java.lang.StringBuffer buf)
Deprecated.
Use {
format(long, Appendable) . |
java.lang.StringBuffer |
format(java.lang.Object obj,
java.lang.StringBuffer toAppendTo,
java.text.FieldPosition pos)
Formats a
Date , Calendar or
Long (milliseconds) object. |
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,
java.util.Locale locale)
Gets a date formatter instance using the specified style and
locale in the default time zone.
|
static FastDateFormat |
getDateInstance(int style,
java.util.TimeZone timeZone)
Gets a date formatter instance using the specified style and
time zone in the default locale.
|
static FastDateFormat |
getDateInstance(int style,
java.util.TimeZone timeZone,
java.util.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,
java.util.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,
java.util.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,
java.util.TimeZone timeZone,
java.util.Locale locale)
Gets a date/time formatter instance using the specified style,
time zone and locale.
|
static FastDateFormat |
getInstance()
Gets a formatter instance using the default pattern in the
default locale.
|
static FastDateFormat |
getInstance(java.lang.String pattern)
Gets a formatter instance using the specified pattern in the
default locale.
|
static FastDateFormat |
getInstance(java.lang.String pattern,
java.util.Locale locale)
Gets a formatter instance using the specified pattern and
locale.
|
static FastDateFormat |
getInstance(java.lang.String pattern,
java.util.TimeZone timeZone)
Gets a formatter instance using the specified pattern and
time zone.
|
static FastDateFormat |
getInstance(java.lang.String pattern,
java.util.TimeZone timeZone,
java.util.Locale locale)
Gets a formatter instance using the specified pattern, time zone
and locale.
|
java.util.Locale |
getLocale()
Gets the locale used by this formatter.
|
int |
getMaxLengthEstimate()
Gets an estimate for the maximum string length that the
formatter will produce.
|
java.lang.String |
getPattern()
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,
java.util.Locale locale)
Gets a time formatter instance using the specified style and
locale in the default time zone.
|
static FastDateFormat |
getTimeInstance(int style,
java.util.TimeZone timeZone)
Gets a time formatter instance using the specified style and
time zone in the default locale.
|
static FastDateFormat |
getTimeInstance(int style,
java.util.TimeZone timeZone,
java.util.Locale locale)
Gets a time formatter instance using the specified style, time
zone and locale.
|
java.util.TimeZone |
getTimeZone()
Gets the time zone used by this formatter.
|
int |
hashCode()
Returns a hash code compatible with equals.
|
java.util.Date |
parse(java.lang.String source)
Equivalent to DateFormat.parse(String).
|
java.util.Date |
parse(java.lang.String source,
java.text.ParsePosition pos)
Equivalent to DateFormat.parse(String, ParsePosition).
|
boolean |
parse(java.lang.String source,
java.text.ParsePosition pos,
java.util.Calendar calendar)
Parses a formatted date string according to the format.
|
java.lang.Object |
parseObject(java.lang.String source,
java.text.ParsePosition pos)
Parses a date/time string according to the given parse position.
|
java.lang.String |
toString()
Gets a debugging string version of this formatter.
|
parseObject
public static final int FULL
public static final int LONG
public static final int MEDIUM
public static final int SHORT
public static FastDateFormat getInstance()
Gets a formatter instance using the default pattern in the default locale.
public static FastDateFormat getInstance(java.lang.String pattern)
Gets a formatter instance using the specified pattern in the default locale.
pattern
- SimpleDateFormat
compatible
patternjava.lang.IllegalArgumentException
- if pattern is invalidpublic static FastDateFormat getInstance(java.lang.String pattern, java.util.TimeZone timeZone)
Gets a formatter instance using the specified pattern and time zone.
pattern
- SimpleDateFormat
compatible
patterntimeZone
- optional time zone, overrides time zone of
formatted datejava.lang.IllegalArgumentException
- if pattern is invalidpublic static FastDateFormat getInstance(java.lang.String pattern, java.util.Locale locale)
Gets a formatter instance using the specified pattern and locale.
pattern
- SimpleDateFormat
compatible
patternlocale
- optional locale, overrides system localejava.lang.IllegalArgumentException
- if pattern is invalidpublic static FastDateFormat getInstance(java.lang.String pattern, java.util.TimeZone timeZone, java.util.Locale locale)
Gets a formatter instance using the specified pattern, time zone and locale.
pattern
- SimpleDateFormat
compatible
patterntimeZone
- optional time zone, overrides time zone of
formatted datelocale
- optional locale, overrides system localejava.lang.IllegalArgumentException
- if pattern is invalid
or null
public static FastDateFormat getDateInstance(int style)
Gets a date formatter instance using the specified style in the default time zone and locale.
style
- date style: FULL, LONG, MEDIUM, or SHORTjava.lang.IllegalArgumentException
- if the Locale has no date
pattern definedpublic static FastDateFormat getDateInstance(int style, java.util.Locale locale)
Gets a date formatter instance using the specified style and locale in the default time zone.
style
- date style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system localejava.lang.IllegalArgumentException
- if the Locale has no date
pattern definedpublic static FastDateFormat getDateInstance(int style, java.util.TimeZone timeZone)
Gets a date formatter instance using the specified style and time zone in the default locale.
style
- date style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of
formatted datejava.lang.IllegalArgumentException
- if the Locale has no date
pattern definedpublic static FastDateFormat getDateInstance(int style, java.util.TimeZone timeZone, java.util.Locale locale)
Gets a date formatter instance using the specified style, time zone and locale.
style
- date style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of
formatted datelocale
- optional locale, overrides system localejava.lang.IllegalArgumentException
- if the Locale has no date
pattern definedpublic static FastDateFormat getTimeInstance(int style)
Gets a time formatter instance using the specified style in the default time zone and locale.
style
- time style: FULL, LONG, MEDIUM, or SHORTjava.lang.IllegalArgumentException
- if the Locale has no time
pattern definedpublic static FastDateFormat getTimeInstance(int style, java.util.Locale locale)
Gets a time formatter instance using the specified style and locale in the default time zone.
style
- time style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system localejava.lang.IllegalArgumentException
- if the Locale has no time
pattern definedpublic static FastDateFormat getTimeInstance(int style, java.util.TimeZone timeZone)
Gets a time formatter instance using the specified style and time zone in the default locale.
style
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of
formatted timejava.lang.IllegalArgumentException
- if the Locale has no time
pattern definedpublic static FastDateFormat getTimeInstance(int style, java.util.TimeZone timeZone, java.util.Locale locale)
Gets a time formatter instance using the specified style, time zone and locale.
style
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of
formatted timelocale
- optional locale, overrides system localejava.lang.IllegalArgumentException
- if the Locale has no time
pattern definedpublic static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle)
Gets a date/time formatter instance using the specified style in the default time zone and locale.
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTjava.lang.IllegalArgumentException
- if the Locale has no date/time
pattern definedpublic static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle, java.util.Locale locale)
Gets a date/time formatter instance using the specified style and locale in the default time zone.
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system localejava.lang.IllegalArgumentException
- if the Locale has no date/time
pattern definedpublic static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle, java.util.TimeZone timeZone)
Gets a date/time formatter instance using the specified style and time zone in the default locale.
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of
formatted datejava.lang.IllegalArgumentException
- if the Locale has no date/time
pattern definedpublic static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle, java.util.TimeZone timeZone, java.util.Locale locale)
Gets a date/time formatter instance using the specified style, time zone and locale.
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 localejava.lang.IllegalArgumentException
- if the Locale has no date/time
pattern definedpublic java.lang.StringBuffer format(java.lang.Object obj, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Formats a Date
, Calendar
or
Long
(milliseconds) object.
Format.format(Object, StringBuffer, FieldPosition)
format
in interface DatePrinter
format
in class java.text.Format
obj
- the object to formattoAppendTo
- the buffer to append topos
- the position - ignoredDateFormat.format(Object, StringBuffer, FieldPosition)
public java.lang.String format(long millis)
Formats a millisecond long
value.
format
in interface DatePrinter
millis
- the millisecond value to formatpublic java.lang.String format(java.util.Date date)
Formats a Date
object using a GregorianCalendar
.
format
in interface DatePrinter
date
- the date to formatpublic java.lang.String format(java.util.Calendar calendar)
Formats a Calendar
object.
format
in interface DatePrinter
calendar
- the calendar to format@Deprecated public java.lang.StringBuffer format(long millis, java.lang.StringBuffer buf)
format(long, Appendable)
.Formats a millisecond long
value into the
supplied StringBuffer
.
format
in interface DatePrinter
millis
- the millisecond value to formatbuf
- the buffer to format into@Deprecated public java.lang.StringBuffer format(java.util.Date date, java.lang.StringBuffer buf)
format(Date, Appendable)
.Formats a Date
object into the
supplied StringBuffer
using a GregorianCalendar
.
format
in interface DatePrinter
date
- the date to formatbuf
- the buffer to format into@Deprecated public java.lang.StringBuffer format(java.util.Calendar calendar, java.lang.StringBuffer buf)
format(Calendar, Appendable)
.Formats a Calendar
object into the
supplied StringBuffer
.
format
in interface DatePrinter
calendar
- the calendar to formatbuf
- the buffer to format intopublic <B extends java.lang.Appendable> B format(long millis, B buf)
Formats a millisecond long
value into the
supplied StringBuffer
.
format
in interface DatePrinter
B
- the Appendable class type, usually StringBuilder or StringBuffer.millis
- the millisecond value to formatbuf
- the buffer to format intopublic <B extends java.lang.Appendable> B format(java.util.Date date, B buf)
Formats a Date
object into the
supplied StringBuffer
using a GregorianCalendar
.
format
in interface DatePrinter
B
- the Appendable class type, usually StringBuilder or StringBuffer.date
- the date to formatbuf
- the buffer to format intopublic <B extends java.lang.Appendable> B format(java.util.Calendar calendar, B buf)
Formats a Calendar
object into the
supplied StringBuffer
.
format
in interface DatePrinter
B
- the Appendable class type, usually StringBuilder or StringBuffer.calendar
- the calendar to formatbuf
- the buffer to format intopublic java.util.Date parse(java.lang.String source) throws java.text.ParseException
DateParser
DateFormat.parse(String)
for more information.parse
in interface DateParser
source
- A String
whose beginning should be parsed.Date
parsed from the stringjava.text.ParseException
- if the beginning of the specified string cannot be parsed.public java.util.Date parse(java.lang.String source, java.text.ParsePosition pos)
DateParser
DateFormat.parse(String, ParsePosition)
for more information.parse
in interface DateParser
source
- A String
, part of which should be parsed.pos
- A ParsePosition
object with index and error index information
as described above.Date
parsed from the string. In case of error, returns null.public boolean parse(java.lang.String source, java.text.ParsePosition pos, java.util.Calendar calendar)
DateParser
parse
in interface DateParser
source
- The text to parse.pos
- On input, the position in the source to start parsing, on output, updated position.calendar
- The calendar into which to set parsed fields.public java.lang.Object parseObject(java.lang.String source, java.text.ParsePosition pos)
DateParser
parseObject
in interface DateParser
parseObject
in class java.text.Format
source
- A String
whose beginning should be parsed.pos
- the parse positionjava.util.Date
objectDateFormat.parseObject(String, ParsePosition)
public java.lang.String getPattern()
Gets the pattern used by this formatter.
getPattern
in interface DateParser
getPattern
in interface DatePrinter
SimpleDateFormat
compatiblepublic java.util.TimeZone getTimeZone()
Gets the time zone used by this formatter.
This zone is always used for Date
formatting.
getTimeZone
in interface DateParser
getTimeZone
in interface DatePrinter
public java.util.Locale getLocale()
Gets the locale used by this formatter.
getLocale
in interface DateParser
getLocale
in interface DatePrinter
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.
public boolean equals(java.lang.Object obj)
Compares two objects for equality.
equals
in class java.lang.Object
obj
- the object to compare totrue
if equalpublic int hashCode()
Returns a hash code compatible with equals.
hashCode
in class java.lang.Object
public java.lang.String toString()
Gets a debugging string version of this formatter.
toString
in class java.lang.Object
Copyright © 2010 - 2020 Adobe. All Rights Reserved