public class FastDatePrinter extends java.lang.Object implements DatePrinter, java.io.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 FormModifier and Type | Class and Description |
---|---|
private static class |
FastDatePrinter.CharacterLiteral
Inner class to output a constant single character.
|
private static class |
FastDatePrinter.DayInWeekField
Inner class to output the numeric day in week.
|
private static class |
FastDatePrinter.Iso8601_Rule
Inner class to output a time zone as a number
+/-HHMM
or +/-HH:MM . |
private static interface |
FastDatePrinter.NumberRule
Inner class defining a numeric rule.
|
private static class |
FastDatePrinter.PaddedNumberField
Inner class to output a padded number.
|
private static interface |
FastDatePrinter.Rule
Inner class defining a rule.
|
private static class |
FastDatePrinter.StringLiteral
Inner class to output a constant string.
|
private static class |
FastDatePrinter.TextField
Inner class to output one of a set of values.
|
private static class |
FastDatePrinter.TimeZoneDisplayKey
Inner class that acts as a compound key for time zone names.
|
private static class |
FastDatePrinter.TimeZoneNameRule
Inner class to output a time zone name.
|
private static class |
FastDatePrinter.TimeZoneNumberRule
Inner class to output a time zone as a number
+/-HHMM
or +/-HH:MM . |
private static class |
FastDatePrinter.TwelveHourField
Inner class to output the twelve hour field.
|
private static class |
FastDatePrinter.TwentyFourHourField
Inner class to output the twenty four hour field.
|
private static class |
FastDatePrinter.TwoDigitMonthField
Inner class to output a two digit month.
|
private static class |
FastDatePrinter.TwoDigitNumberField
Inner class to output a two digit number.
|
private static class |
FastDatePrinter.TwoDigitYearField
Inner class to output a two digit year.
|
private static class |
FastDatePrinter.UnpaddedMonthField
Inner class to output an unpadded month.
|
private static class |
FastDatePrinter.UnpaddedNumberField
Inner class to output an unpadded number.
|
private static class |
FastDatePrinter.WeekYear
Inner class to output the numeric day in week.
|
Modifier and Type | Field and Description |
---|---|
private static java.util.concurrent.ConcurrentMap<FastDatePrinter.TimeZoneDisplayKey,java.lang.String> |
cTimeZoneDisplayCache |
static int |
FULL
FULL locale dependent date or time style.
|
static int |
LONG
LONG locale dependent date or time style.
|
private static int |
MAX_DIGITS |
static int |
MEDIUM
MEDIUM locale dependent date or time style.
|
private java.util.Locale |
mLocale
The locale.
|
private int |
mMaxLengthEstimate
The estimated maximum length.
|
private java.lang.String |
mPattern
The pattern.
|
private FastDatePrinter.Rule[] |
mRules
The parsed rules.
|
private java.util.TimeZone |
mTimeZone
The time zone.
|
private static long |
serialVersionUID
Required for serialization support.
|
static int |
SHORT
SHORT locale dependent date or time style.
|
Modifier | Constructor and Description |
---|---|
protected |
FastDatePrinter(java.lang.String pattern,
java.util.TimeZone timeZone,
java.util.Locale locale)
Constructs a new FastDatePrinter.
|
Modifier and Type | Method and Description |
---|---|
private static void |
appendDigits(java.lang.Appendable buffer,
int value)
Appends two digits to the given buffer.
|
private static void |
appendFullDigits(java.lang.Appendable buffer,
int value,
int minFieldWidth)
Appends all digits to the given buffer.
|
private <B extends java.lang.Appendable> |
applyRules(java.util.Calendar calendar,
B buf)
Performs the formatting by applying the rules to the
specified calendar.
|
protected java.lang.StringBuffer |
applyRules(java.util.Calendar calendar,
java.lang.StringBuffer buf)
Deprecated.
|
private java.lang.String |
applyRulesToString(java.util.Calendar c)
Creates a String representation of the given Calendar by applying the rules of this printer to it.
|
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 Appendable . |
java.lang.StringBuffer |
format(java.util.Calendar calendar,
java.lang.StringBuffer buf)
Formats a
Calendar object into the supplied StringBuffer . |
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 Appendable using a GregorianCalendar . |
java.lang.StringBuffer |
format(java.util.Date date,
java.lang.StringBuffer buf)
Formats a
Date object into the
supplied StringBuffer using a GregorianCalendar . |
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 Appendable . |
java.lang.StringBuffer |
format(long millis,
java.lang.StringBuffer buf)
Formats a millisecond
long value into the
supplied StringBuffer . |
(package private) java.lang.String |
format(java.lang.Object obj)
Formats a
Date , Calendar or
Long (milliseconds) object. |
java.lang.StringBuffer |
format(java.lang.Object obj,
java.lang.StringBuffer toAppendTo,
java.text.FieldPosition pos)
Deprecated.
Use {
format(Date) , {format(Calendar) , {format(long) , or {format(Object) |
java.util.Locale |
getLocale()
Gets the locale used by this printer.
|
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 printer.
|
java.util.TimeZone |
getTimeZone()
Gets the time zone used by this printer.
|
(package private) static java.lang.String |
getTimeZoneDisplay(java.util.TimeZone tz,
boolean daylight,
int style,
java.util.Locale locale)
Gets the time zone display name, using a cache for performance.
|
int |
hashCode()
Returns a hashcode compatible with equals.
|
private void |
init()
Initializes the instance for first use.
|
private java.util.Calendar |
newCalendar()
Creation method for new calender instances.
|
protected java.util.List<FastDatePrinter.Rule> |
parsePattern()
Returns a list of Rules given a pattern.
|
protected java.lang.String |
parseToken(java.lang.String pattern,
int[] indexRef)
Performs the parsing of tokens.
|
private void |
readObject(java.io.ObjectInputStream in)
Create the object after serialization.
|
protected FastDatePrinter.NumberRule |
selectNumberRule(int field,
int padding)
Gets an appropriate rule for the padding required.
|
java.lang.String |
toString()
Gets a debugging string version of this formatter.
|
private static final long serialVersionUID
Serializable
,
Constant Field Valuespublic static final int FULL
public static final int LONG
public static final int MEDIUM
public static final int SHORT
private final java.lang.String mPattern
private final java.util.TimeZone mTimeZone
private final java.util.Locale mLocale
private transient FastDatePrinter.Rule[] mRules
private transient int mMaxLengthEstimate
private static final int MAX_DIGITS
private static final java.util.concurrent.ConcurrentMap<FastDatePrinter.TimeZoneDisplayKey,java.lang.String> cTimeZoneDisplayCache
protected FastDatePrinter(java.lang.String pattern, java.util.TimeZone timeZone, java.util.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 usejava.lang.NullPointerException
- if pattern, timeZone, or locale is null.private void init()
Initializes the instance for first use.
protected java.util.List<FastDatePrinter.Rule> parsePattern()
Returns a list of Rules given a pattern.
List
of Rule objectsjava.lang.IllegalArgumentException
- if pattern is invalidprotected java.lang.String parseToken(java.lang.String pattern, int[] indexRef)
Performs the parsing of tokens.
pattern
- the patternindexRef
- index referencesprotected 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 java.lang.StringBuffer format(java.lang.Object obj, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
format(Date)
, {format(Calendar)
, {format(long)
, or {format(Object)
Formats a Date
, Calendar
or
Long
(milliseconds) object.
format
in interface DatePrinter
obj
- the object to formattoAppendTo
- the buffer to append topos
- the position - ignoredDateFormat.format(Object, StringBuffer, FieldPosition)
java.lang.String format(java.lang.Object obj)
Formats a Date
, Calendar
or
Long
(milliseconds) object.
obj
- the object to formatpublic java.lang.String format(long millis)
DatePrinter
Formats a millisecond long
value.
format
in interface DatePrinter
millis
- the millisecond value to formatprivate java.lang.String applyRulesToString(java.util.Calendar c)
c
- the Calender to apply the rules to.private java.util.Calendar newCalendar()
public java.lang.String format(java.util.Date date)
DatePrinter
Formats a Date
object using a GregorianCalendar
.
format
in interface DatePrinter
date
- the date to formatpublic java.lang.String format(java.util.Calendar calendar)
DatePrinter
Formats a Calendar
object.
format
in interface DatePrinter
calendar
- the calendar to format.public java.lang.StringBuffer format(long millis, java.lang.StringBuffer buf)
DatePrinter
Formats a millisecond long
value into the
supplied StringBuffer
.
format
in interface DatePrinter
millis
- the millisecond value to formatbuf
- the buffer to format intopublic java.lang.StringBuffer format(java.util.Date date, java.lang.StringBuffer buf)
DatePrinter
Formats a Date
object into the
supplied StringBuffer
using a GregorianCalendar
.
format
in interface DatePrinter
date
- the date to formatbuf
- the buffer to format intopublic java.lang.StringBuffer format(java.util.Calendar calendar, java.lang.StringBuffer buf)
DatePrinter
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)
DatePrinter
Formats a millisecond long
value into the
supplied Appendable
.
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)
DatePrinter
Formats a Date
object into the
supplied Appendable
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)
DatePrinter
Formats a Calendar
object into the supplied Appendable
.
format
in interface DatePrinter
B
- the Appendable class type, usually StringBuilder or StringBuffer.calendar
- the calendar to formatbuf
- the buffer to format into@Deprecated protected java.lang.StringBuffer applyRules(java.util.Calendar calendar, java.lang.StringBuffer buf)
format(Calendar)
or format(Calendar, Appendable)
calendar
- the calendar to formatbuf
- the buffer to format intoprivate <B extends java.lang.Appendable> B applyRules(java.util.Calendar calendar, B buf)
Performs the formatting by applying the rules to the specified calendar.
B
- the Appendable class type, usually StringBuilder or StringBuffer.calendar
- the calendar to formatbuf
- the buffer to format intopublic java.lang.String getPattern()
DatePrinter
Gets the pattern used by this printer.
getPattern
in interface DatePrinter
SimpleDateFormat
compatiblepublic java.util.TimeZone getTimeZone()
DatePrinter
Gets the time zone used by this printer.
This zone is always used for Date
printing.
getTimeZone
in interface DatePrinter
public java.util.Locale getLocale()
DatePrinter
Gets the locale used by this printer.
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 hashcode 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
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
in
- ObjectInputStream from which the object is being deserialized.java.io.IOException
- if there is an IO issue.java.lang.ClassNotFoundException
- if a class cannot be found.private static void appendDigits(java.lang.Appendable buffer, int value) throws java.io.IOException
buffer
- the buffer to append to.value
- the value to append digits from.java.io.IOException
private static void appendFullDigits(java.lang.Appendable buffer, int value, int minFieldWidth) throws java.io.IOException
buffer
- the buffer to append to.value
- the value to append digits from.java.io.IOException
static java.lang.String getTimeZoneDisplay(java.util.TimeZone tz, boolean daylight, int style, java.util.Locale locale)
Gets the time zone display name, using a cache for performance.
tz
- the zone to querydaylight
- true if daylight savingsstyle
- the style to use TimeZone.LONG
or TimeZone.SHORT
locale
- the locale to use