Class FastDateFormat
- All Implemented Interfaces:
Serializable,Cloneable,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 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.
- Since:
- 2.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.text.Format
Format.Field -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedFastDateFormat(String pattern, TimeZone timeZone, Locale locale) Constructs a new FastDateFormat.protectedFastDateFormat(String pattern, TimeZone timeZone, Locale locale, Date centuryStart) Constructs a new FastDateFormat. -
Method Summary
Modifier and TypeMethodDescriptionprotected StringBufferapplyRules(Calendar calendar, StringBuffer buf) Deprecated.booleanCompares two objects for equality.format(long millis) Formats a millisecondlongvalue.<B extends Appendable>
Bformat(long millis, B buf) Formats a millisecondlongvalue into the suppliedStringBuffer.format(long millis, StringBuffer buf) Deprecated.Use {format(long, Appendable).format(Object obj, StringBuffer toAppendTo, FieldPosition pos) Formats aCalendarobject.<B extends Appendable>
BFormats aCalendarobject into the suppliedStringBuffer.format(Calendar calendar, StringBuffer buf) Deprecated.Formats aDateobject using aGregorianCalendar.<B extends Appendable>
Bformat(Date date, StringBuffer buf) Deprecated.Use {format(Date, Appendable).static FastDateFormatgetDateInstance(int style) Gets a date formatter instance using the specified style in the default time zone and locale.static FastDateFormatgetDateInstance(int style, Locale locale) Gets a date formatter instance using the specified style and locale in the default time zone.static FastDateFormatgetDateInstance(int style, TimeZone timeZone) Gets a date formatter instance using the specified style and time zone in the default locale.static FastDateFormatgetDateInstance(int style, TimeZone timeZone, Locale locale) Gets a date formatter instance using the specified style, time zone and locale.static FastDateFormatgetDateTimeInstance(int dateStyle, int timeStyle) Gets a date/time formatter instance using the specified style in the default time zone and locale.static FastDateFormatgetDateTimeInstance(int dateStyle, int timeStyle, Locale locale) Gets a date/time formatter instance using the specified style and locale in the default time zone.static FastDateFormatgetDateTimeInstance(int dateStyle, int timeStyle, TimeZone timeZone) Gets a date/time formatter instance using the specified style and time zone in the default locale.static FastDateFormatgetDateTimeInstance(int dateStyle, int timeStyle, TimeZone timeZone, Locale locale) Gets a date/time formatter instance using the specified style, time zone and locale.static FastDateFormatGets a formatter instance using the default pattern in the default locale.static FastDateFormatgetInstance(String pattern) Gets a formatter instance using the specified pattern in the default locale.static FastDateFormatgetInstance(String pattern, Locale locale) Gets a formatter instance using the specified pattern and locale.static FastDateFormatgetInstance(String pattern, TimeZone timeZone) Gets a formatter instance using the specified pattern and time zone.static FastDateFormatgetInstance(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.intGets an estimate for the maximum string length that the formatter will produce.Gets the pattern used by this formatter.static FastDateFormatgetTimeInstance(int style) Gets a time formatter instance using the specified style in the default time zone and locale.static FastDateFormatgetTimeInstance(int style, Locale locale) Gets a time formatter instance using the specified style and locale in the default time zone.static FastDateFormatgetTimeInstance(int style, TimeZone timeZone) Gets a time formatter instance using the specified style and time zone in the default locale.static FastDateFormatgetTimeInstance(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.inthashCode()Returns a hash code compatible with equals.Equivalent to DateFormat.parse(String).parse(String source, ParsePosition pos) Equivalent to DateFormat.parse(String, ParsePosition).booleanparse(String source, ParsePosition pos, Calendar calendar) Parses a formatted date string according to the format.parseObject(String source, ParsePosition pos) Parses a date/time string according to the given parse position.toString()Gets a debugging string version of this formatter.Methods inherited from class java.text.Format
clone, format, formatToCharacterIterator, parseObjectMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.commons.lang3.time.DateParser
parseObject
-
Field Details
-
FULL
FULL locale dependent date or time style.- See Also:
-
LONG
LONG locale dependent date or time style.- See Also:
-
MEDIUM
MEDIUM locale dependent date or time style.- See Also:
-
SHORT
SHORT locale dependent date or time style.- See Also:
-
-
Constructor Details
-
FastDateFormat
Constructs a new FastDateFormat.- Parameters:
pattern-SimpleDateFormatcompatible 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-SimpleDateFormatcompatible 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
-
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
-
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
-
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-SimpleDateFormatcompatible pattern- 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-SimpleDateFormatcompatible 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 and time zone.- Parameters:
pattern-SimpleDateFormatcompatible 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, time zone and locale.- Parameters:
pattern-SimpleDateFormatcompatible 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
-
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
-
applyRules
Deprecated.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
-
equals
Compares two objects for equality. -
format
Formats aCalendarobject.- Specified by:
formatin interfaceDatePrinter- Parameters:
calendar- the calendar to format- Returns:
- the formatted string
-
format
Formats aCalendarobject into the suppliedStringBuffer.- Specified by:
formatin 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
-
format
Deprecated.Formats aCalendarobject into the suppliedStringBuffer.- Specified by:
formatin interfaceDatePrinter- Parameters:
calendar- the calendar to formatbuf- the buffer to format into- Returns:
- the specified string buffer
-
format
Formats aDateobject using aGregorianCalendar.- Specified by:
formatin interfaceDatePrinter- Parameters:
date- the date to format- Returns:
- the formatted string
-
format
- Specified by:
formatin 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
Deprecated.Use {format(Date, Appendable).- Specified by:
formatin interfaceDatePrinter- Parameters:
date- the date to formatbuf- the buffer to format into- Returns:
- the specified string buffer
-
format
Formats a millisecondlongvalue.- Specified by:
formatin interfaceDatePrinter- Parameters:
millis- the millisecond value to format- Returns:
- the formatted string
- Since:
- 2.1
-
format
Formats a millisecondlongvalue into the suppliedStringBuffer.- Specified by:
formatin 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
Deprecated.Use {format(long, Appendable).Formats a millisecondlongvalue into the suppliedStringBuffer.- Specified by:
formatin interfaceDatePrinter- Parameters:
millis- the millisecond value to formatbuf- the buffer to format into- Returns:
- the specified string buffer
- Since:
- 2.1
-
format
Formats aDate,CalendarorLong(milliseconds) object. This method is an implementation ofFormat.format(Object, StringBuffer, FieldPosition)- Specified by:
formatin interfaceDatePrinter- Specified by:
formatin classFormat- Parameters:
obj- the object to formattoAppendTo- the buffer to append topos- the position - ignored- Returns:
- the buffer passed in
- See Also:
-
getLocale
Gets the locale used by this formatter.- Specified by:
getLocalein interfaceDateParser- Specified by:
getLocalein interfaceDatePrinter- Returns:
- the locale
-
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
-
getPattern
Gets the pattern used by this formatter.- Specified by:
getPatternin interfaceDateParser- Specified by:
getPatternin interfaceDatePrinter- Returns:
- the pattern,
SimpleDateFormatcompatible
-
getTimeZone
Gets the time zone used by this formatter.This zone is always used for
Dateformatting.- Specified by:
getTimeZonein interfaceDateParser- Specified by:
getTimeZonein interfaceDatePrinter- Returns:
- the time zone
-
hashCode
Returns a hash code compatible with equals. -
parse
Description copied from interface:DateParserEquivalent to DateFormat.parse(String). SeeDateFormat.parse(String)for more information.- Specified by:
parsein interfaceDateParser- Parameters:
source- AStringwhose beginning should be parsed.- Returns:
- A
Dateparsed from the string. - Throws:
ParseException- if the beginning of the specified string cannot be parsed.
-
parse
Description copied from interface:DateParserEquivalent to DateFormat.parse(String, ParsePosition). SeeDateFormat.parse(String, ParsePosition)for more information.- Specified by:
parsein interfaceDateParser- Parameters:
source- AString, part of which should be parsed.pos- AParsePositionobject with index and error index information as described above.- Returns:
- A
Dateparsed from the string. In case of error, returns null.
-
parse
Description copied from interface:DateParserParses a formatted date string according to the format. Updates the Calendar with parsed fields. Upon success, the ParsePosition index is updated to indicate how much of the source text was consumed. Not all source text needs to be consumed. Upon parse failure, ParsePosition error index is updated to the offset of the source text which does not match the supplied format.- Specified by:
parsein interfaceDateParser- Parameters:
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.- Returns:
- true, if source has been parsed (pos parsePosition is updated); otherwise false (and pos errorIndex is updated)
-
parseObject
Description copied from interface:DateParserParses a date/time string according to the given parse position.- Specified by:
parseObjectin interfaceDateParser- Specified by:
parseObjectin classFormat- Parameters:
source- AStringwhose beginning should be parsed.pos- the parse position.- Returns:
- a
Dateobject. - See Also:
-
toString
Gets a debugging string version of this formatter.
-
format(Calendar, Appendable)