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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
Inner class to output a constant single character.private static class
Inner class to output the numeric day in week.private static class
Inner class to output a time zone as a number+/-HHMM
or+/-HH:MM
.private static interface
Inner class defining a numeric rule.private static final class
Inner class to output a padded number.private static interface
Inner class defining a rule.private static class
Inner class to output a constant string.private static class
Inner class to output one of a set of values.private static class
Inner class that acts as a compound key for time zone names.private static class
Inner class to output a time zone name.private static class
Inner class to output a time zone as a number+/-HHMM
or+/-HH:MM
.private static class
Inner class to output the twelve hour field.private static class
Inner class to output the twenty four hour field.private static class
Inner class to output a two digit month.private static class
Inner class to output a two digit number.private static class
Inner class to output a two digit year.private static class
Inner class to output an unpadded month.private static class
Inner class to output an unpadded number.private static class
Inner class to output the numeric day in week. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final ConcurrentMap
<FastDatePrinter.TimeZoneDisplayKey, String> private static final FastDatePrinter.Rule[]
Empty array.static final int
FULL locale dependent date or time style.private final Locale
The locale.static final int
LONG locale dependent date or time style.private static final int
private int
The estimated maximum length.static final int
MEDIUM locale dependent date or time style.private final String
The pattern.private FastDatePrinter.Rule[]
The parsed rules.private static final long
Required for serialization support.static final int
SHORT locale dependent date or time style.private final TimeZone
The time zone. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
FastDatePrinter
(String pattern, TimeZone timeZone, Locale locale) Constructs a new FastDatePrinter. -
Method Summary
Modifier and TypeMethodDescriptionprivate static void
appendDigits
(Appendable buffer, int value) Appends two digits to the given buffer.private static void
appendFullDigits
(Appendable buffer, int value, int minFieldWidth) Appends all digits to the given buffer.private <B extends Appendable>
BapplyRules
(Calendar calendar, B buf) Performs the formatting by applying the rules to the specified calendar.protected StringBuffer
applyRules
(Calendar calendar, StringBuffer buf) Deprecated.private String
Creates a String representation of the given Calendar by applying the rules of this printer to it.boolean
Compares two objects for equality.format
(long millis) Formats a millisecondlong
value.<B extends Appendable>
Bformat
(long millis, B buf) Formats a millisecondlong
value into the suppliedAppendable
.format
(long millis, StringBuffer buf) Formats a millisecondlong
value into the suppliedStringBuffer
.(package private) String
format
(Object obj, StringBuffer toAppendTo, FieldPosition pos) Deprecated.Formats aCalendar
object.<B extends Appendable>
BFormats aCalendar
object into the suppliedAppendable
.format
(Calendar calendar, StringBuffer buf) Formats aCalendar
object into the suppliedStringBuffer
.Formats aDate
object using aGregorianCalendar
.<B extends Appendable>
Bformat
(Date date, StringBuffer buf) Gets the locale used by this printer.int
Gets 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.(package private) static String
getTimeZoneDisplay
(TimeZone tz, boolean daylight, int style, Locale locale) Gets the time zone display name, using a cache for performance.int
hashCode()
Returns a hash code compatible with equals.private void
init()
Initializes the instance for first use.private Calendar
Creates a new Calendar instance.protected List
<FastDatePrinter.Rule> Returns a list of Rules given a pattern.protected String
parseToken
(String pattern, int[] indexRef) Performs the parsing of tokens.private void
Create the object after serialization.protected FastDatePrinter.NumberRule
selectNumberRule
(int field, int padding) Gets an appropriate rule for the padding required.toString()
Gets a debugging string version of this formatter.
-
Field Details
-
EMPTY_RULE_ARRAY
Empty array. -
serialVersionUID
private static final long serialVersionUIDRequired for serialization support.- See Also:
-
FULL
public static final int FULLFULL locale dependent date or time style.- See Also:
-
LONG
public static final int LONGLONG locale dependent date or time style.- See Also:
-
MEDIUM
public static final int MEDIUMMEDIUM locale dependent date or time style.- See Also:
-
SHORT
public static final int SHORTSHORT locale dependent date or time style.- See Also:
-
MAX_DIGITS
private static final int MAX_DIGITS- See Also:
-
cTimeZoneDisplayCache
-
pattern
The pattern. -
timeZone
The time zone. -
locale
The locale. -
rules
The parsed rules. -
maxLengthEstimate
private transient int maxLengthEstimateThe estimated maximum length.
-
-
Constructor Details
-
FastDatePrinter
Constructs a new FastDatePrinter. UseFastDateFormat.getInstance(String, TimeZone, Locale)
or another variation of the factory methods ofFastDateFormat
to get a cached FastDatePrinter instance.- Parameters:
pattern
-SimpleDateFormat
compatible patterntimeZone
- non-null time zone to uselocale
- non-null locale to use- Throws:
NullPointerException
- if pattern, timeZone, or locale is null.
-
-
Method Details
-
appendDigits
Appends two digits to the given buffer.- Parameters:
buffer
- the buffer to append to.value
- the value to append digits from.- Throws:
IOException
- If an I/O error occurs
-
appendFullDigits
private static void appendFullDigits(Appendable buffer, int value, int minFieldWidth) throws IOException Appends all digits to the given buffer.- Parameters:
buffer
- the buffer to append to.value
- the value to append digits from.minFieldWidth
- Minimum field width.- Throws:
IOException
- If an I/O error occurs
-
getTimeZoneDisplay
Gets the time zone display name, using a cache for performance.- Parameters:
tz
- the zone to querydaylight
- true if daylight savingsstyle
- the style to useTimeZone.LONG
orTimeZone.SHORT
locale
- the locale to use- Returns:
- the textual name of the time zone
-
applyRules
Performs the formatting by applying the rules to the specified calendar.- 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
-
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
-
applyRulesToString
Creates a String representation of the given Calendar by applying the rules of this printer to it.- Parameters:
c
- the Calendar to apply the rules to.- Returns:
- a String representation of the given Calendar.
-
equals
Compares two objects for equality. -
format
Description copied from interface:DatePrinter
Formats aCalendar
object. 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:
format
in interfaceDatePrinter
- Parameters:
calendar
- the calendar to format.- Returns:
- the formatted string
-
format
Description copied from interface:DatePrinter
Formats aCalendar
object 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:
format
in 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:DatePrinter
Formats aCalendar
object 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:
format
in interfaceDatePrinter
- Parameters:
calendar
- the calendar to formatbuf
- the buffer to format into- Returns:
- the specified string buffer
-
format
Description copied from interface:DatePrinter
Formats aDate
object using aGregorianCalendar
.- Specified by:
format
in interfaceDatePrinter
- Parameters:
date
- the date to format- Returns:
- the formatted string
-
format
Description copied from interface:DatePrinter
- Specified by:
format
in 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:
format
in interfaceDatePrinter
- Parameters:
date
- the date to formatbuf
- the buffer to format into- Returns:
- the specified string buffer
-
format
Description copied from interface:DatePrinter
Formats a millisecondlong
value.- Specified by:
format
in interfaceDatePrinter
- Parameters:
millis
- the millisecond value to format- Returns:
- the formatted string
-
format
Description copied from interface:DatePrinter
Formats a millisecondlong
value into the suppliedAppendable
.- Specified by:
format
in 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:DatePrinter
Formats a millisecondlong
value into the suppliedStringBuffer
.- Specified by:
format
in interfaceDatePrinter
- Parameters:
millis
- the millisecond value to formatbuf
- the buffer to format into- Returns:
- the specified string buffer
-
format
- Parameters:
obj
- the object to format- Returns:
- The formatted value.
- Since:
- 3.5
-
format
Deprecated.- Specified by:
format
in 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:DatePrinter
Gets the locale used by this printer.- Specified by:
getLocale
in interfaceDatePrinter
- Returns:
- the locale
-
getMaxLengthEstimate
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.
- Returns:
- the maximum formatted length
-
getPattern
Description copied from interface:DatePrinter
Gets the pattern used by this printer.- Specified by:
getPattern
in interfaceDatePrinter
- Returns:
- the pattern,
SimpleDateFormat
compatible
-
getTimeZone
Description copied from interface:DatePrinter
Gets the time zone used by this printer.This zone is always used for
Date
printing.- Specified by:
getTimeZone
in interfaceDatePrinter
- Returns:
- the time zone
-
hashCode
public int hashCode()Returns a hash code compatible with equals. -
init
private void init()Initializes the instance for first use. -
newCalendar
Creates a new Calendar instance.- Returns:
- a new Calendar instance.
-
parsePattern
Returns a list of Rules given a pattern.- Returns:
- a
List
of Rule objects - Throws:
IllegalArgumentException
- if pattern is invalid
-
parseToken
Performs the parsing of tokens.- Parameters:
pattern
- the patternindexRef
- index references- Returns:
- parsed token
-
readObject
Create the object after serialization. This implementation reinitializes the transient properties.- Parameters:
in
- ObjectInputStream from which the object is being deserialized.- Throws:
IOException
- if there is an IO issue.ClassNotFoundException
- if a class cannot be found.
-
selectNumberRule
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)