public class FastDateFormat extends Format implements DateParser, DatePrinter
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 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.
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.
Format.Field
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 | Constructor and Description |
---|---|
protected |
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.
|
Modifier and Type | Method and Description |
---|---|
protected StringBuffer |
applyRules(Calendar calendar,
StringBuffer buf)
Performs the formatting by applying the rules to the specified calendar.
|
boolean |
equals(Object obj)
Compares two objects for equality.
|
String |
format(Calendar calendar)
Formats a
Calendar object. |
StringBuffer |
format(Calendar calendar,
StringBuffer buf)
Formats a
Calendar object into the supplied StringBuffer . |
String |
format(Date date)
Formats a
Date object using a GregorianCalendar . |
StringBuffer |
format(Date date,
StringBuffer buf)
Formats a
Date object into the supplied StringBuffer using a GregorianCalendar . |
String |
format(long millis)
Formats a millisecond
long value. |
StringBuffer |
format(long millis,
StringBuffer buf)
Formats a millisecond
long value into the supplied StringBuffer . |
StringBuffer |
format(Object obj,
StringBuffer toAppendTo,
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,
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 |
getInstance()
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.
|
Locale |
getLocale()
Gets the locale used by this formatter.
|
int |
getMaxLengthEstimate()
Gets an estimate for the maximum string length that the formatter will produce.
|
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,
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.
|
TimeZone |
getTimeZone()
Gets the time zone used by this formatter.
|
int |
hashCode()
Returns a hashcode compatible with equals.
|
Date |
parse(String source)
Equivalent to DateFormat.parse(String).
|
Date |
parse(String source,
ParsePosition pos)
Equivalent to DateFormat.parse(String, ParsePosition).
|
Object |
parseObject(String source,
ParsePosition pos)
Parse a date/time string according to the given parse position.
|
String |
toString()
Gets a debugging string version of this formatter.
|
clone, format, formatToCharacterIterator, parseObject
finalize, getClass, notify, notifyAll, wait, wait, wait
parseObject
public static final int FULL
public static final int LONG
public static final int MEDIUM
public static final int SHORT
protected FastDateFormat(String pattern, TimeZone timeZone, Locale locale)
pattern
- SimpleDateFormat
compatible patterntimeZone
- non-null time zone to uselocale
- non-null locale to useNullPointerException
- if pattern, timeZone, or locale is null.protected FastDateFormat(String pattern, TimeZone timeZone, Locale locale, Date centuryStart)
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 yearsNullPointerException
- if pattern, timeZone, or locale is null.public static FastDateFormat getInstance()
public static FastDateFormat getInstance(String pattern)
pattern
- SimpleDateFormat
compatible patternIllegalArgumentException
- if pattern is invalidpublic static FastDateFormat getInstance(String pattern, TimeZone timeZone)
pattern
- SimpleDateFormat
compatible patterntimeZone
- optional time zone, overrides time zone of formatted dateIllegalArgumentException
- if pattern is invalidpublic static FastDateFormat getInstance(String pattern, Locale locale)
pattern
- SimpleDateFormat
compatible patternlocale
- optional locale, overrides system localeIllegalArgumentException
- if pattern is invalidpublic static FastDateFormat getInstance(String pattern, TimeZone timeZone, Locale locale)
pattern
- SimpleDateFormat
compatible patterntimeZone
- optional time zone, overrides time zone of formatted datelocale
- optional locale, overrides system localeIllegalArgumentException
- if pattern is invalid or null
public static FastDateFormat getDateInstance(int style)
style
- date style: FULL, LONG, MEDIUM, or SHORTIllegalArgumentException
- if the Locale has no date pattern definedpublic static FastDateFormat getDateInstance(int style, Locale locale)
style
- date style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system localeIllegalArgumentException
- if the Locale has no date pattern definedpublic static FastDateFormat getDateInstance(int style, TimeZone timeZone)
style
- date style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted dateIllegalArgumentException
- if the Locale has no date pattern definedpublic static FastDateFormat getDateInstance(int style, TimeZone timeZone, Locale locale)
style
- date style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted datelocale
- optional locale, overrides system localeIllegalArgumentException
- if the Locale has no date pattern definedpublic static FastDateFormat getTimeInstance(int style)
style
- time style: FULL, LONG, MEDIUM, or SHORTIllegalArgumentException
- if the Locale has no time pattern definedpublic static FastDateFormat getTimeInstance(int style, Locale locale)
style
- time style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system localeIllegalArgumentException
- if the Locale has no time pattern definedpublic static FastDateFormat getTimeInstance(int style, TimeZone timeZone)
style
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted timeIllegalArgumentException
- if the Locale has no time pattern definedpublic static FastDateFormat getTimeInstance(int style, TimeZone timeZone, Locale locale)
style
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted timelocale
- optional locale, overrides system localeIllegalArgumentException
- if the Locale has no time pattern definedpublic static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle)
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTIllegalArgumentException
- if the Locale has no date/time pattern definedpublic static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle, Locale locale)
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTlocale
- optional locale, overrides system localeIllegalArgumentException
- if the Locale has no date/time pattern definedpublic static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle, TimeZone timeZone)
dateStyle
- date style: FULL, LONG, MEDIUM, or SHORTtimeStyle
- time style: FULL, LONG, MEDIUM, or SHORTtimeZone
- optional time zone, overrides time zone of formatted dateIllegalArgumentException
- if the Locale has no date/time pattern definedpublic static FastDateFormat getDateTimeInstance(int dateStyle, int timeStyle, TimeZone timeZone, Locale 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 localeIllegalArgumentException
- if the Locale has no date/time pattern definedpublic StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
Date
, Calendar
or Long
(milliseconds) object.format
in interface DatePrinter
format
in class Format
obj
- the object to formattoAppendTo
- the buffer to append topos
- the position - ignoredpublic String format(long millis)
long
value.format
in interface DatePrinter
millis
- the millisecond value to formatpublic String format(Date date)
Date
object using a GregorianCalendar
.format
in interface DatePrinter
date
- the date to formatpublic String format(Calendar calendar)
Calendar
object.format
in interface DatePrinter
calendar
- the calendar to formatpublic StringBuffer format(long millis, StringBuffer buf)
long
value into the supplied StringBuffer
.format
in interface DatePrinter
millis
- the millisecond value to formatbuf
- the buffer to format intopublic StringBuffer format(Date date, StringBuffer buf)
Date
object into the supplied StringBuffer
using a GregorianCalendar
.format
in interface DatePrinter
date
- the date to formatbuf
- the buffer to format intopublic StringBuffer format(Calendar calendar, StringBuffer buf)
Calendar
object into the supplied StringBuffer
.format
in interface DatePrinter
calendar
- the calendar to formatbuf
- the buffer to format intopublic Date parse(String source) throws ParseException
DateParser
See DateFormat.parse(String)
for more information.
parse
in interface DateParser
source
- A String
whose beginning should be parsed.Date
parsed from the stringParseException
- if the beginning of the specified string cannot be parsed.public Date parse(String source, ParsePosition pos)
DateParser
See 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 Object parseObject(String source, ParsePosition pos)
DateParser
parseObject
in interface DateParser
parseObject
in class Format
source
- A String
whose beginning should be parsed.pos
- the parse positionjava.util.Date
objectDateFormat.parseObject(String, ParsePosition)
public String getPattern()
getPattern
in interface DateParser
getPattern
in interface DatePrinter
SimpleDateFormat
compatiblepublic TimeZone getTimeZone()
This zone is always used for Date
formatting.
getTimeZone
in interface DateParser
getTimeZone
in interface DatePrinter
public Locale getLocale()
getLocale
in interface DateParser
getLocale
in interface DatePrinter
public int getMaxLengthEstimate()
The actual formatted length will almost always be less than or equal to this amount.
public boolean equals(Object obj)
public int hashCode()
public String toString()
protected StringBuffer applyRules(Calendar calendar, StringBuffer buf)
calendar
- the calendar to formatbuf
- the buffer to format intoCopyright © 2022. All rights reserved.