FastDatePrinter

public class org.apache.commons.lang3.time.FastDatePrinter implements DatePrinter, Serializable

FastDatePrinter is a fast and thread-safe version of java.text.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 (for example, +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 (for example, +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

Constructors

FastDatePrinter(String, TimeZone, Locale)

Constructs a new FastDatePrinter.

protected FastDatePrinter(String pattern, TimeZone timeZone, Locale locale)

Constructs a new FastDatePrinter. Use FastDateFormat#getInstance(String, TimeZone, Locale) or another variation of the factory methods of FastDateFormat to get a cached FastDatePrinter instance.

Parameters:

• pattern – java.text.SimpleDateFormat compatible pattern.

• timeZone – non-null time zone to use.

• locale – non-null locale to use.

Throws:

java.lang.NullPointerException – Thrown if pattern, timeZone, or locale is null.

Fields and constants

FULL	FULL locale dependent date or time style.
LONG	LONG locale dependent date or time style.
MEDIUM	MEDIUM locale dependent date or time style.
SHORT	SHORT locale dependent date or time style.

public static final int FULL = 0

FULL locale dependent date or time style.

public static final int LONG = 1

LONG locale dependent date or time style.

public static final int MEDIUM = 2

MEDIUM locale dependent date or time style.

public static final int SHORT = 3

SHORT locale dependent date or time style.

Methods

applyRules(Calendar, StringBuffer)	Deprecated. Performs the formatting by applying the rules to the specified calendar.
equals(Object)	Compares two objects for equality.
format(Object, StringBuffer, FieldPosition)	Deprecated. Formats a Date, Calendar or Long (milliseconds) object.
format(Calendar)	Formats a Calendar object.
format(Calendar, Appendable)	Formats a Calendar object into the supplied Appendable.
format(Calendar, StringBuffer)	Formats a Calendar object into the supplied StringBuffer.
format(Date)	Formats a Date object using a GregorianCalendar.
format(Date, Appendable)	Formats a Date object into the supplied Appendable using a GregorianCalendar.
format(Date, StringBuffer)	Formats a Date object into the supplied StringBuffer using a GregorianCalendar.
format(long)	Formats a millisecond long value.
format(long, Appendable)	Formats a millisecond long value into the supplied Appendable.
format(long, StringBuffer)	Formats a millisecond long value into the supplied StringBuffer.
getLocale()	Gets the locale used by this printer.
getMaxLengthEstimate()	Gets an estimate for the maximum string length that the formatter will produce.
getPattern()	Gets the pattern used by this printer.
getTimeZone()	Gets the time zone used by this printer.
hashCode()	Returns a hash code compatible with equals.
parsePattern()	Returns a list of Rules given a pattern.
parseToken(String, int[])	Performs the parsing of tokens.
selectNumberRule(int, int)	Gets an appropriate rule for the padding required.
toString()	Gets a debugging string version of this formatter.

@Deprecated protected StringBuffer applyRules(Calendar calendar, StringBuffer buf)

Deprecated: Use #format(Calendar) or #format(Calendar, Appendable)

Performs the formatting by applying the rules to the specified calendar.

Parameters:

• calendar – The calendar to format.

• buf – The buffer to format into.

Returns:

The specified string buffer.

@Override public boolean equals(Object obj)

Compares two objects for equality.

Parameters:

obj – The object to compare to.

Returns:

true if equal.

@Deprecated @Override public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)

Deprecated: Use {#format(Date), {#format(Calendar), {#format(long).

Formats a Date, Calendar or Long (milliseconds) object.

Parameters:

• obj – The object to format.

• toAppendTo – The buffer to append to.

• pos – The position; ignored.

Returns:

The buffer passed in.

@Override public String format(Calendar calendar)

Formats a Calendar 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.

Parameters:

calendar – The calendar to format.

Returns:

The formatted string.

@Override public <B extends Appendable> B format(Calendar calendar, B buf)

Formats a Calendar object into the supplied Appendable. 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.

Parameters:

• calendar – The calendar to format.

• buf – The buffer to format into.

Type parameters:

<B> – The Appendable class type, usually StringBuilder or StringBuffer.

Returns:

The specified string buffer.

@Override public StringBuffer format(Calendar calendar, StringBuffer buf)

Formats a Calendar object into the supplied StringBuffer. 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.

Parameters:

• calendar – The calendar to format.

• buf – The buffer to format into.

Returns:

The specified string buffer.

@Override public String format(Date date)

Formats a Date object using a GregorianCalendar.

Parameters:

date – The date to format

Returns:

The formatted string

@Override public <B extends Appendable> B format(Date date, B buf)

Formats a Date object into the supplied Appendable using a GregorianCalendar.

Parameters:

• date – The date to format.

• buf – The buffer to format into.

Type parameters:

<B> – The Appendable class type, usually StringBuilder or StringBuffer.

Returns:

The specified string buffer.

@Override public StringBuffer format(Date date, StringBuffer buf)

Formats a Date object into the supplied StringBuffer using a GregorianCalendar.

Parameters:

• date – The date to format.

• buf – The buffer to format into.

Returns:

The specified string buffer.

@Override public String format(long millis)

Formats a millisecond long value.

Parameters:

millis – The millisecond value to format.

Returns:

The formatted string.

@Override public <B extends Appendable> B format(long millis, B buf)

Formats a millisecond long value into the supplied Appendable.

Parameters:

• millis – The millisecond value to format.

• buf – The buffer to format into.

Type parameters:

<B> – The Appendable class type, usually StringBuilder or StringBuffer.

Returns:

The specified string buffer.

@Override public StringBuffer format(long millis, StringBuffer buf)

Formats a millisecond long value into the supplied StringBuffer.

Parameters:

• millis – The millisecond value to format.

• buf – The buffer to format into.

Returns:

The specified string buffer.

@Override public Locale getLocale()

Gets the locale used by this printer.

Returns:

The locale.

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.

@Override public String getPattern()

Gets the pattern used by this printer.

Returns:

The pattern, java.text.SimpleDateFormat compatible.

@Override public TimeZone getTimeZone()

Gets the time zone used by this printer.

This zone is always used for Date printing.

Returns:

The time zone.

@Override public int hashCode()

Returns a hash code compatible with equals.

Returns:

A hash code compatible with equals.

protected List<FastDatePrinter.Rule> parsePattern()

Returns a list of Rules given a pattern.

Returns:

A List of Rule objects.

Throws:

java.lang.IllegalArgumentException – Thrown if pattern is invalid.

protected String parseToken(String pattern, int[] indexRef)

Performs the parsing of tokens.

Parameters:

• pattern – The pattern.

• indexRef – index references.

Returns:

parsed token.

protected FastDatePrinter.NumberRule selectNumberRule(int field, int padding)

Gets an appropriate rule for the padding required.

Parameters:

• field – The field to get a rule for.

• padding – The padding required.

Returns:

A new rule with the correct padding.

@Override public String toString()

Gets a debugging string version of this formatter.

Returns:

A debugging string.