Class FastDatePrinter
- java.lang.Object
-
- org.apache.commons.lang3.time.FastDatePrinter
-
- All Implemented Interfaces:
java.io.Serializable
,DatePrinter
public class FastDatePrinter extends java.lang.Object implements DatePrinter, java.io.Serializable
FastDatePrinter is a fast and thread-safe version ofSimpleDateFormat
.To obtain a FastDatePrinter, use
FastDateFormat.getInstance(String, TimeZone, Locale)
or another variation of the factory methods ofFastDateFormat
.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:
FastDateParser
, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class 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.
-
Field Summary
Fields Modifier and Type Field Description private static java.util.concurrent.ConcurrentMap<FastDatePrinter.TimeZoneDisplayKey,java.lang.String>
cTimeZoneDisplayCache
private static FastDatePrinter.Rule[]
EMPTY_RULE_ARRAY
Empty array.static int
FULL
FULL locale dependent date or time style.private java.util.Locale
locale
The locale.static int
LONG
LONG locale dependent date or time style.private static int
MAX_DIGITS
private int
maxLengthEstimate
The estimated maximum length.static int
MEDIUM
MEDIUM locale dependent date or time style.private java.lang.String
pattern
The pattern.private FastDatePrinter.Rule[]
rules
The parsed rules.private static long
serialVersionUID
Required for serialization support.static int
SHORT
SHORT locale dependent date or time style.private java.util.TimeZone
timeZone
The time zone.
-
Constructor Summary
Constructors Modifier Constructor Description protected
FastDatePrinter(java.lang.String pattern, java.util.TimeZone timeZone, java.util.Locale locale)
Constructs a new FastDatePrinter.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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>
BapplyRules(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(long millis)
Formats a millisecondlong
value.<B extends java.lang.Appendable>
Bformat(long millis, B buf)
Formats a millisecondlong
value into the suppliedAppendable
.java.lang.StringBuffer
format(long millis, java.lang.StringBuffer buf)
Formats a millisecondlong
value into the suppliedStringBuffer
.(package private) java.lang.String
format(java.lang.Object obj)
Formats aDate
,Calendar
orLong
(milliseconds) object.java.lang.StringBuffer
format(java.lang.Object obj, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Deprecated.java.lang.String
format(java.util.Calendar calendar)
Formats aCalendar
object.<B extends java.lang.Appendable>
Bformat(java.util.Calendar calendar, B buf)
Formats aCalendar
object into the suppliedAppendable
.java.lang.StringBuffer
format(java.util.Calendar calendar, java.lang.StringBuffer buf)
Formats aCalendar
object into the suppliedStringBuffer
.java.lang.String
format(java.util.Date date)
Formats aDate
object using aGregorianCalendar
.<B extends java.lang.Appendable>
Bformat(java.util.Date date, B buf)
Formats aDate
object into the suppliedAppendable
using aGregorianCalendar
.java.lang.StringBuffer
format(java.util.Date date, java.lang.StringBuffer buf)
Formats aDate
object into the suppliedStringBuffer
using aGregorianCalendar
.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 hash code compatible with equals.private void
init()
Initializes the instance for first use.private java.util.Calendar
newCalendar()
Creates a new Calendar instance.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.
-
-
-
Field Detail
-
EMPTY_RULE_ARRAY
private static final FastDatePrinter.Rule[] EMPTY_RULE_ARRAY
Empty array.
-
serialVersionUID
private static final long serialVersionUID
Required for serialization support.- See Also:
Serializable
, Constant Field Values
-
FULL
public static final int FULL
FULL locale dependent date or time style.- See Also:
- Constant Field Values
-
LONG
public static final int LONG
LONG locale dependent date or time style.- See Also:
- Constant Field Values
-
MEDIUM
public static final int MEDIUM
MEDIUM locale dependent date or time style.- See Also:
- Constant Field Values
-
SHORT
public static final int SHORT
SHORT locale dependent date or time style.- See Also:
- Constant Field Values
-
MAX_DIGITS
private static final int MAX_DIGITS
- See Also:
- Constant Field Values
-
cTimeZoneDisplayCache
private static final java.util.concurrent.ConcurrentMap<FastDatePrinter.TimeZoneDisplayKey,java.lang.String> cTimeZoneDisplayCache
-
pattern
private final java.lang.String pattern
The pattern.
-
timeZone
private final java.util.TimeZone timeZone
The time zone.
-
locale
private final java.util.Locale locale
The locale.
-
rules
private transient FastDatePrinter.Rule[] rules
The parsed rules.
-
maxLengthEstimate
private transient int maxLengthEstimate
The estimated maximum length.
-
-
Constructor Detail
-
FastDatePrinter
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 ofFastDateFormat
to get a cached FastDatePrinter instance.- Parameters:
pattern
-SimpleDateFormat
compatible patterntimeZone
- non-null time zone to uselocale
- non-null locale to use- Throws:
java.lang.NullPointerException
- if pattern, timeZone, or locale is null.
-
-
Method Detail
-
appendDigits
private static void appendDigits(java.lang.Appendable buffer, int value) throws java.io.IOException
Appends two digits to the given buffer.- Parameters:
buffer
- the buffer to append to.value
- the value to append digits from.- Throws:
java.io.IOException
- If an I/O error occurs
-
appendFullDigits
private static void appendFullDigits(java.lang.Appendable buffer, int value, int minFieldWidth) throws java.io.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:
java.io.IOException
- If an I/O error occurs
-
getTimeZoneDisplay
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.- 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
private <B extends java.lang.Appendable> B applyRules(java.util.Calendar calendar, B buf)
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 protected java.lang.StringBuffer applyRules(java.util.Calendar calendar, java.lang.StringBuffer buf)
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
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.- Parameters:
c
- the Calendar to apply the rules to.- Returns:
- a String representation of the given Calendar.
-
equals
public boolean equals(java.lang.Object obj)
Compares two objects for equality.- Overrides:
equals
in classjava.lang.Object
- Parameters:
obj
- the object to compare to- Returns:
true
if equal
-
format
public java.lang.String format(java.util.Calendar calendar)
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
public <B extends java.lang.Appendable> B format(java.util.Calendar calendar, B buf)
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
public java.lang.StringBuffer format(java.util.Calendar calendar, java.lang.StringBuffer buf)
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
public java.lang.String format(java.util.Date date)
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
public <B extends java.lang.Appendable> B format(java.util.Date date, B buf)
Description copied from interface:DatePrinter
Formats aDate
object into the suppliedAppendable
using aGregorianCalendar
.- 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
public java.lang.StringBuffer format(java.util.Date date, java.lang.StringBuffer buf)
Description copied from interface:DatePrinter
Formats aDate
object into the suppliedStringBuffer
using aGregorianCalendar
.- Specified by:
format
in interfaceDatePrinter
- Parameters:
date
- the date to formatbuf
- the buffer to format into- Returns:
- the specified string buffer
-
format
public java.lang.String format(long millis)
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
public <B extends java.lang.Appendable> B format(long millis, B buf)
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
public java.lang.StringBuffer format(long millis, java.lang.StringBuffer buf)
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
java.lang.String format(java.lang.Object obj)
Formats aDate
,Calendar
orLong
(milliseconds) object.- Parameters:
obj
- the object to format- Returns:
- The formatted value.
- Since:
- 3.5
-
format
@Deprecated public java.lang.StringBuffer format(java.lang.Object obj, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos)
Deprecated.Formats aDate
,Calendar
orLong
(milliseconds) object.- 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:
DateFormat.format(Object, StringBuffer, FieldPosition)
-
getLocale
public java.util.Locale 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
public java.lang.String getPattern()
Description copied from interface:DatePrinter
Gets the pattern used by this printer.- Specified by:
getPattern
in interfaceDatePrinter
- Returns:
- the pattern,
SimpleDateFormat
compatible
-
getTimeZone
public java.util.TimeZone 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.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- a hash code compatible with equals
-
init
private void init()
Initializes the instance for first use.
-
newCalendar
private java.util.Calendar newCalendar()
Creates a new Calendar instance.- Returns:
- a new Calendar instance.
-
parsePattern
protected java.util.List<FastDatePrinter.Rule> parsePattern()
Returns a list of Rules given a pattern.- Returns:
- a
List
of Rule objects - Throws:
java.lang.IllegalArgumentException
- if pattern is invalid
-
parseToken
protected java.lang.String parseToken(java.lang.String pattern, int[] indexRef)
Performs the parsing of tokens.- Parameters:
pattern
- the patternindexRef
- index references- Returns:
- parsed token
-
readObject
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
Create the object after serialization. This implementation reinitializes the transient properties.- Parameters:
in
- ObjectInputStream from which the object is being deserialized.- Throws:
java.io.IOException
- if there is an IO issue.java.lang.ClassNotFoundException
- if a class cannot be found.
-
selectNumberRule
protected 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
public java.lang.String toString()
Gets a debugging string version of this formatter.- Overrides:
toString
in classjava.lang.Object
- Returns:
- a debugging string
-
-