Class FastDatePrinter
- All Implemented Interfaces:
Serializable,DatePrinter
SimpleDateFormat.
To obtain a FastDatePrinter, use FastDateFormat.getInstance(String, TimeZone, Locale)
or another variation of the factory methods of FastDateFormat.
Since FastDatePrinter is thread safe, you can use a static member instance:
private static final DatePrinter DATE_PRINTER = FastDateFormat.getInstance("yyyy-MM-dd");
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 by this class, but all patterns are compatible with SimpleDateFormat (except time zones and some year patterns - 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
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.
Starting with JDK7, ISO 8601 support was added using the pattern 'X'.
To maintain compatibility, 'ZZ' will continue to be supported, but using
one of the 'X' formats is recommended.
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. FastDatePrinter implements the behavior of Java 7.
- Since:
- 3.2
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedFastDatePrinter(String pattern, TimeZone timeZone, Locale locale) Constructs a new FastDatePrinter. -
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 suppliedAppendable.format(long millis, StringBuffer buf) Formats a millisecondlongvalue into the suppliedStringBuffer.format(Object obj, StringBuffer toAppendTo, FieldPosition pos) Deprecated.Formats aCalendarobject.<B extends Appendable>
BFormats aCalendarobject into the suppliedAppendable.format(Calendar calendar, StringBuffer buf) Formats aCalendarobject into the suppliedStringBuffer.Formats aDateobject using aGregorianCalendar.<B extends Appendable>
Bformat(Date date, StringBuffer buf) Gets the locale used by this printer.intGets an estimate for the maximum string length that the formatter will produce.Gets the pattern used by this printer.Gets the time zone used by this printer.inthashCode()Returns a hash code compatible with equals.protected List<org.apache.commons.lang3.time.FastDatePrinter.Rule> Returns a list of Rules given a pattern.protected StringparseToken(String pattern, int[] indexRef) Performs the parsing of tokens.protected org.apache.commons.lang3.time.FastDatePrinter.NumberRuleselectNumberRule(int field, int padding) Gets an appropriate rule for the padding required.toString()Gets a debugging string version of this formatter.
-
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
-
FastDatePrinter
Constructs a new FastDatePrinter. UseFastDateFormat.getInstance(String, TimeZone, Locale)or another variation of the factory methods ofFastDateFormatto get a cached FastDatePrinter instance.- Parameters:
pattern-SimpleDateFormatcompatible patterntimeZone- non-null time zone to uselocale- non-null locale to use- Throws:
NullPointerException- if pattern, timeZone, or locale is null.
-
-
Method Details
-
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
Description copied from interface:DatePrinterFormats aCalendarobject. The TimeZone set on the Calendar is only used to adjust the time offset. The TimeZone specified during the construction of the Parser will determine the TimeZone used in the formatted string.- Specified by:
formatin interfaceDatePrinter- Parameters:
calendar- the calendar to format.- Returns:
- the formatted string
-
format
Description copied from interface:DatePrinterFormats aCalendarobject into the suppliedAppendable. The TimeZone set on the Calendar is only used to adjust the time offset. The TimeZone specified during the construction of the Parser will determine the TimeZone used in the formatted string.- 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
-
format
Description copied from interface:DatePrinterFormats aCalendarobject into the suppliedStringBuffer. The TimeZone set on the Calendar is only used to adjust the time offset. The TimeZone specified during the construction of the Parser will determine the TimeZone used in the formatted string.- Specified by:
formatin interfaceDatePrinter- Parameters:
calendar- the calendar to formatbuf- the buffer to format into- Returns:
- the specified string buffer
-
format
Description copied from interface:DatePrinterFormats aDateobject using aGregorianCalendar.- Specified by:
formatin interfaceDatePrinter- Parameters:
date- the date to format- Returns:
- the formatted string
-
format
Description copied from interface:DatePrinter- 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
-
format
Description copied from interface:DatePrinter- Specified by:
formatin interfaceDatePrinter- Parameters:
date- the date to formatbuf- the buffer to format into- Returns:
- the specified string buffer
-
format
Description copied from interface:DatePrinterFormats a millisecondlongvalue.- Specified by:
formatin interfaceDatePrinter- Parameters:
millis- the millisecond value to format- Returns:
- the formatted string
-
format
Description copied from interface:DatePrinterFormats a millisecondlongvalue into the suppliedAppendable.- 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
-
format
Description copied from interface:DatePrinterFormats 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
-
format
Deprecated.- Specified by:
formatin interfaceDatePrinter- Parameters:
obj- the object to formattoAppendTo- the buffer to append topos- the position - ignored- Returns:
- the buffer passed in
- See Also:
-
getLocale
Description copied from interface:DatePrinterGets the locale used by this printer.- 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
Description copied from interface:DatePrinterGets the pattern used by this printer.- Specified by:
getPatternin interfaceDatePrinter- Returns:
- the pattern,
SimpleDateFormatcompatible
-
getTimeZone
Description copied from interface:DatePrinterGets the time zone used by this printer.This zone is always used for
Dateprinting.- Specified by:
getTimeZonein interfaceDatePrinter- Returns:
- the time zone
-
hashCode
Returns a hash code compatible with equals. -
parsePattern
Returns a list of Rules given a pattern.- Returns:
- a
Listof 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.lang3.time.FastDatePrinter.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
-
toString
Gets a debugging string version of this formatter.
-
format(Calendar)orformat(Calendar, Appendable)