Class FastDatePrinter
- All Implemented Interfaces:
Serializable,DatePrinter
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.
Copied and modified from Apache Commons Lang.
- Since:
- Apache Commons Lang 3.2
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static classInner class to output a constant single character.private static classInner class to output the numeric day in week.private static classInner class to output a time zone as a number+/-HHMMor+/-HH:MM.private static interfaceInner class defining a numeric rule.private static classInner class to output a padded number.private static interfaceInner class defining a rule.private static classInner class to output a constant string.private static classInner class to output one of a set of values.private static classInner class that acts as a compound key for time zone names.private static classInner class to output a time zone name.private static classInner class to output a time zone as a number+/-HHMMor+/-HH:MM.private static classInner class to output the twelve hour field.private static classInner class to output the twenty four hour field.private static classInner class to output a two digit month.private static classInner class to output a two digit number.private static classInner class to output a two digit year.private static classInner class to output an unpadded month.private static classInner class to output an unpadded number.private static classInner class to output the numeric day in week. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final ConcurrentMap<FastDatePrinter.TimeZoneDisplayKey, String> static final intFULL locale dependent date or time style.static final intLONG locale dependent date or time style.private static final intstatic final intMEDIUM locale dependent date or time style.private final LocaleThe locale.private intThe estimated maximum length.private final StringThe pattern.private FastDatePrinter.Rule[]The parsed rules.private final TimeZoneThe time zone.private static final longRequired for serialization support.static final intSHORT locale dependent date or time style. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedFastDatePrinter(String pattern, TimeZone timeZone, Locale locale) Constructs a new FastDatePrinter. -
Method Summary
Modifier and TypeMethodDescriptionprivate static voidappendDigits(Appendable buffer, int value) Appends two digits to the given buffer.private static voidappendFullDigits(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 StringBufferapplyRules(Calendar calendar, StringBuffer buf) Deprecated.private StringCreates a String representation of the given Calendar by applying the rules of this printer to it.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.(package private) StringFormats aDate,CalendarorLong(milliseconds) object.format(Object obj, StringBuilder toAppendTo, FieldPosition pos) Deprecated.Formats aCalendarobject.<B extends Appendable>
BFormats aCalendarobject into the suppliedAppendable.Formats aDateobject using aGregorianCalendar.<B extends Appendable>
BFormats aDateobject into the suppliedAppendableusing aGregorianCalendar.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.(package private) static StringgetTimeZoneDisplay(TimeZone tz, boolean daylight, int style, Locale locale) Gets the time zone display name, using a cache for performance.inthashCode()Returns a hash code compatible with equals.private voidinit()Initializes the instance for first use.private CalendarCreation method for new calender instances.protected List<FastDatePrinter.Rule> Returns a list of Rules given a pattern.protected StringparseToken(String pattern, int[] indexRef) Performs the parsing of tokens.private voidCreate the object after serialization.protected 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
-
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:
-
mPattern
The pattern. -
mTimeZone
The time zone. -
mLocale
The locale. -
mRules
The parsed rules. -
mMaxLengthEstimate
private transient int mMaxLengthEstimateThe estimated maximum length. -
MAX_DIGITS
private static final int MAX_DIGITS- See Also:
-
cTimeZoneDisplayCache
-
-
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
-
init
private void init()Initializes the instance for first use.
-
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
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
-
format
Deprecated.Formats a
Date,CalendarorLong(milliseconds) object.- 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:
-
format
Formats a
Date,CalendarorLong(milliseconds) object.- Parameters:
obj- the object to format- Returns:
- The formatted value.
- Since:
- 3.5
-
format
Description copied from interface:DatePrinterFormats a millisecond
longvalue.- Specified by:
formatin interfaceDatePrinter- Parameters:
millis- the millisecond value to format- Returns:
- the formatted string
-
applyRulesToString
Creates a String representation of the given Calendar by applying the rules of this printer to it.- Parameters:
c- the Calender to apply the rules to.- Returns:
- a String representation of the given Calendar.
-
newCalendar
Creation method for new calender instances.- Returns:
- a new Calendar instance.
-
format
Description copied from interface:DatePrinterFormats a
Dateobject using aGregorianCalendar.- Specified by:
formatin interfaceDatePrinter- Parameters:
date- the date to format- Returns:
- the formatted string
-
format
Description copied from interface:DatePrinterFormats a
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.Calendarobject.- Specified by:
formatin interfaceDatePrinter- Parameters:
calendar- the calendar to format.- Returns:
- the formatted string
-
format
Description copied from interface:DatePrinterFormats a millisecond
longvalue 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
Dateobject into the suppliedAppendableusing aGregorianCalendar.- 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:DatePrinterFormats a
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.Calendarobject into the suppliedAppendable.- 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
-
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
-
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
-
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
-
getLocale
Description copied from interface:DatePrinterGets the locale used by this printer.
- Specified by:
getLocalein 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
-
equals
Compares two objects for equality.
-
hashCode
public int hashCode()Returns a hash code compatible with equals.
-
toString
Gets a debugging string version of this formatter.
-
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.
-
appendDigits
Appends two digits to the given buffer.- Parameters:
buffer- the buffer to append to.value- the value to append digits from.- Throws:
IOException
-
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.- Throws:
IOException
-
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.LONGorTimeZone.SHORTlocale- the locale to use- Returns:
- the textual name of the time zone
-
format(Calendar)orformat(Calendar, Appendable)