public class FastDatePrinter extends Object implements DatePrinter, Serializable
FastDatePrinter is a fast and thread-safe version of
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.
FastDateParser,
Serialized Form| 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 |
FastDatePrinter(String pattern,
TimeZone timeZone,
Locale locale)
Constructs a new FastDatePrinter.
|
| Modifier and Type | Method and Description |
|---|---|
protected StringBuffer |
applyRules(Calendar calendar,
StringBuffer buf)
Deprecated.
|
boolean |
equals(Object obj)
Compares two objects for equality.
|
String |
format(Calendar calendar)
Formats a
Calendar object. |
<B extends Appendable> |
format(Calendar calendar,
B buf)
Formats a
Calendar object into the supplied Appendable. |
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. |
<B extends Appendable> |
format(Date date,
B buf)
Formats a
Date object into the
supplied Appendable 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. |
<B extends Appendable> |
format(long millis,
B buf)
Formats a millisecond
long value into the
supplied Appendable. |
StringBuffer |
format(long millis,
StringBuffer buf)
Formats a millisecond
long value into the
supplied StringBuffer. |
StringBuffer |
format(Object obj,
StringBuffer toAppendTo,
FieldPosition pos)
Deprecated.
Use {
format(Date), {format(Calendar), {format(long), or {format(Object) |
Locale |
getLocale()
Gets the locale used by this printer.
|
int |
getMaxLengthEstimate()
Gets an estimate for the maximum string length that the
formatter will produce.
|
String |
getPattern()
Gets the pattern used by this printer.
|
TimeZone |
getTimeZone()
Gets the time zone used by this printer.
|
int |
hashCode()
Returns a hash code compatible with equals.
|
protected List<org.apache.commons.lang3.time.FastDatePrinter.Rule> |
parsePattern()
Returns a list of Rules given a pattern.
|
protected String |
parseToken(String pattern,
int[] indexRef)
Performs the parsing of tokens.
|
protected org.apache.commons.lang3.time.FastDatePrinter.NumberRule |
selectNumberRule(int field,
int padding)
Gets an appropriate rule for the padding required.
|
String |
toString()
Gets a debugging string version of this formatter.
|
public static final int FULL
public static final int LONG
public static final int MEDIUM
public static final int SHORT
protected FastDatePrinter(String pattern, TimeZone timeZone, Locale locale)
Constructs a new FastDatePrinter.
UseFastDateFormat.getInstance(String, TimeZone, Locale) or another variation of the
factory methods of FastDateFormat to get a cached FastDatePrinter instance.pattern - SimpleDateFormat compatible patterntimeZone - non-null time zone to uselocale - non-null locale to useNullPointerException - if pattern, timeZone, or locale is null.protected List<org.apache.commons.lang3.time.FastDatePrinter.Rule> parsePattern()
Returns a list of Rules given a pattern.
List of Rule objectsIllegalArgumentException - if pattern is invalidprotected String parseToken(String pattern, int[] indexRef)
Performs the parsing of tokens.
pattern - the patternindexRef - index referencesprotected org.apache.commons.lang3.time.FastDatePrinter.NumberRule selectNumberRule(int field,
int padding)
Gets an appropriate rule for the padding required.
field - the field to get a rule forpadding - the padding required@Deprecated public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)
format(Date), {format(Calendar), {format(long), or {format(Object)Formats a Date, Calendar or
Long (milliseconds) object.
format in interface DatePrinterobj - the object to formattoAppendTo - the buffer to append topos - the position - ignoredDateFormat.format(Object, StringBuffer, FieldPosition)public String format(long millis)
DatePrinterFormats a millisecond long value.
format in interface DatePrintermillis - the millisecond value to formatpublic String format(Date date)
DatePrinterFormats a Date object using a GregorianCalendar.
format in interface DatePrinterdate - the date to formatpublic String format(Calendar calendar)
DatePrinterFormats a Calendar object.
format in interface DatePrintercalendar - the calendar to format.public StringBuffer format(long millis, StringBuffer buf)
DatePrinterFormats a millisecond long value into the
supplied StringBuffer.
format in interface DatePrintermillis - the millisecond value to formatbuf - the buffer to format intopublic StringBuffer format(Date date, StringBuffer buf)
DatePrinterFormats a Date object into the
supplied StringBuffer using a GregorianCalendar.
format in interface DatePrinterdate - the date to formatbuf - the buffer to format intopublic StringBuffer format(Calendar calendar, StringBuffer buf)
DatePrinterFormats a Calendar object into the supplied StringBuffer.
format in interface DatePrintercalendar - the calendar to formatbuf - the buffer to format intopublic <B extends Appendable> B format(long millis, B buf)
DatePrinterFormats a millisecond long value into the
supplied Appendable.
format in interface DatePrinterB - the Appendable class type, usually StringBuilder or StringBuffer.millis - the millisecond value to formatbuf - the buffer to format intopublic <B extends Appendable> B format(Date date, B buf)
DatePrinterFormats a Date object into the
supplied Appendable using a GregorianCalendar.
format in interface DatePrinterB - the Appendable class type, usually StringBuilder or StringBuffer.date - the date to formatbuf - the buffer to format intopublic <B extends Appendable> B format(Calendar calendar, B buf)
DatePrinterFormats a Calendar object into the supplied Appendable.
format in interface DatePrinterB - the Appendable class type, usually StringBuilder or StringBuffer.calendar - the calendar to formatbuf - the buffer to format into@Deprecated protected StringBuffer applyRules(Calendar calendar, StringBuffer buf)
format(Calendar) or format(Calendar, Appendable)calendar - the calendar to formatbuf - the buffer to format intopublic String getPattern()
DatePrinterGets the pattern used by this printer.
getPattern in interface DatePrinterSimpleDateFormat compatiblepublic TimeZone getTimeZone()
DatePrinterGets the time zone used by this printer.
This zone is always used for Date printing.
getTimeZone in interface DatePrinterpublic Locale getLocale()
DatePrinterGets the locale used by this printer.
getLocale in interface DatePrinterpublic 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(Object obj)
Compares two objects for equality.
public int hashCode()
Returns a hash code compatible with equals.
Copyright © 2001–2018 The Apache Software Foundation. All rights reserved.