Class FastDatePrinter

java.lang.Object

org.apache.logging.log4j.core.util.datetime.FastDatePrinter

All Implemented Interfaces:

Serializable, DatePrinter

@Deprecated
public class FastDatePrinter
extends Object
implements DatePrinter, Serializable

Deprecated.

Starting with version 2.25.0, this class is assumed to be internal and planned to be removed in the next major release.

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:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FastDatePrinter.CharacterLiteral	Deprecated. Inner class to output a constant single character.
private static class	FastDatePrinter.DayInWeekField	Deprecated. Inner class to output the numeric day in week.
private static class	FastDatePrinter.Iso8601_Rule	Deprecated. Inner class to output a time zone as a number +/-HHMM or +/-HH:MM.
private static interface	FastDatePrinter.NumberRule	Deprecated. Inner class defining a numeric rule.
private static class	FastDatePrinter.PaddedNumberField	Deprecated. Inner class to output a padded number.
private static interface	FastDatePrinter.Rule	Deprecated. Inner class defining a rule.
private static class	FastDatePrinter.StringLiteral	Deprecated. Inner class to output a constant string.
private static class	FastDatePrinter.TextField	Deprecated. Inner class to output one of a set of values.
private static class	FastDatePrinter.TimeZoneDisplayKey	Deprecated. Inner class that acts as a compound key for time zone names.
private static class	FastDatePrinter.TimeZoneNameRule	Deprecated. Inner class to output a time zone name.
private static class	FastDatePrinter.TimeZoneNumberRule	Deprecated. Inner class to output a time zone as a number +/-HHMM or +/-HH:MM.
private static class	FastDatePrinter.TwelveHourField	Deprecated. Inner class to output the twelve hour field.
private static class	FastDatePrinter.TwentyFourHourField	Deprecated. Inner class to output the twenty four hour field.
private static class	FastDatePrinter.TwoDigitMonthField	Deprecated. Inner class to output a two digit month.
private static class	FastDatePrinter.TwoDigitNumberField	Deprecated. Inner class to output a two digit number.
private static class	FastDatePrinter.TwoDigitYearField	Deprecated. Inner class to output a two digit year.
private static class	FastDatePrinter.UnpaddedMonthField	Deprecated. Inner class to output an unpadded month.
private static class	FastDatePrinter.UnpaddedNumberField	Deprecated. Inner class to output an unpadded number.
private static class	FastDatePrinter.WeekYear	Deprecated. Inner class to output the numeric day in week.

Field Summary

Fields

Modifier and Type	Field	Description
private static final ConcurrentMap<FastDatePrinter.TimeZoneDisplayKey, String>	cTimeZoneDisplayCache	Deprecated.
static final int	FULL	Deprecated. FULL locale dependent date or time style.
static final int	LONG	Deprecated. LONG locale dependent date or time style.
private static final int	MAX_DIGITS	Deprecated.
static final int	MEDIUM	Deprecated. MEDIUM locale dependent date or time style.
private final Locale	mLocale	Deprecated. The locale.
private int	mMaxLengthEstimate	Deprecated. The estimated maximum length.
private final String	mPattern	Deprecated. The pattern.
private FastDatePrinter.Rule[]	mRules	Deprecated. The parsed rules.
private final TimeZone	mTimeZone	Deprecated. The time zone.
private static final long	serialVersionUID	Deprecated. Required for serialization support.
static final int	SHORT	Deprecated. SHORT locale dependent date or time style.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FastDatePrinter(String pattern, TimeZone timeZone, Locale locale)	Deprecated. Constructs a new FastDatePrinter.

Method Summary

Modifier and Type	Method	Description
private static void	appendDigits(Appendable buffer, int value)	Deprecated. Appends two digits to the given buffer.
private static void	appendFullDigits(Appendable buffer, int value, int minFieldWidth)	Deprecated. Appends all digits to the given buffer.
private <B extends Appendable> B	applyRules(Calendar calendar, B buf)	Deprecated. Performs the formatting by applying the rules to the specified calendar.
protected StringBuffer	applyRules(Calendar calendar, StringBuffer buf)	Deprecated. use format(Calendar) or format(Calendar, Appendable)
private String	applyRulesToString(Calendar c)	Deprecated. Creates a String representation of the given Calendar by applying the rules of this printer to it.
boolean	equals(Object obj)	Deprecated. Compares two objects for equality.
String	format(long millis)	Deprecated. Formats a millisecond long value.
<B extends Appendable> B	format(long millis, B buf)	Deprecated. Formats a millisecond long value into the supplied Appendable.
(package private) String	format(Object obj)	Deprecated. Formats a Date, Calendar or Long (milliseconds) object.
StringBuilder	format(Object obj, StringBuilder toAppendTo, FieldPosition pos)	Deprecated. Use {format(Date), {format(Calendar), {format(long), or {format(Object)
String	format(Calendar calendar)	Deprecated. Formats a Calendar object.
<B extends Appendable> B	format(Calendar calendar, B buf)	Deprecated. Formats a Calendar object into the supplied Appendable.
String	format(Date date)	Deprecated. Formats a Date object using a GregorianCalendar.
<B extends Appendable> B	format(Date date, B buf)	Deprecated. Formats a Date object into the supplied Appendable using a GregorianCalendar.
Locale	getLocale()	Deprecated. Gets the locale used by this printer.
int	getMaxLengthEstimate()	Deprecated. Gets an estimate for the maximum string length that the formatter will produce.
String	getPattern()	Deprecated. Gets the pattern used by this printer.
TimeZone	getTimeZone()	Deprecated. Gets the time zone used by this printer.
(package private) static String	getTimeZoneDisplay(TimeZone tz, boolean daylight, int style, Locale locale)	Deprecated. Gets the time zone display name, using a cache for performance.
int	hashCode()	Deprecated. Returns a hash code compatible with equals.
private void	init()	Deprecated. Initializes the instance for first use.
private Calendar	newCalendar()	Deprecated. Creation method for new calendar instances.
protected List<FastDatePrinter.Rule>	parsePattern()	Deprecated. Returns a list of Rules given a pattern.
protected String	parseToken(String pattern, int[] indexRef)	Deprecated. Performs the parsing of tokens.
private void	readObject(ObjectInputStream in)	Deprecated. Create the object after serialization.
protected FastDatePrinter.NumberRule	selectNumberRule(int field, int padding)	Deprecated. Gets an appropriate rule for the padding required.
String	toString()	Deprecated. Gets a debugging string version of this formatter.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

Deprecated.

Required for serialization support.

See Also:

• Serializable
• Constant Field Values

FULL

public static final int FULL

Deprecated.

FULL locale dependent date or time style.

See Also:

• Constant Field Values

LONG

public static final int LONG

Deprecated.

LONG locale dependent date or time style.

See Also:

• Constant Field Values

MEDIUM

public static final int MEDIUM

Deprecated.

MEDIUM locale dependent date or time style.

See Also:

• Constant Field Values

SHORT

public static final int SHORT

Deprecated.

SHORT locale dependent date or time style.

See Also:

• Constant Field Values

mPattern

private final String mPattern

Deprecated.

The pattern.

mTimeZone

private final TimeZone mTimeZone

Deprecated.

The time zone.

mLocale

private final Locale mLocale

Deprecated.

The locale.

mRules

private transient FastDatePrinter.Rule[] mRules

Deprecated.

The parsed rules.

mMaxLengthEstimate

private transient int mMaxLengthEstimate

Deprecated.

The estimated maximum length.

MAX_DIGITS

private static final int MAX_DIGITS

Deprecated.

See Also:

• Constant Field Values

cTimeZoneDisplayCache

private static final ConcurrentMap<FastDatePrinter.TimeZoneDisplayKey, String> cTimeZoneDisplayCache

Deprecated.

Constructor Details

FastDatePrinter

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

Deprecated.

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 - SimpleDateFormat compatible pattern

timeZone - non-null time zone to use

locale - non-null locale to use

Throws:

NullPointerException - if pattern, timeZone, or locale is null.

Method Details

init

private void init()

Deprecated.

Initializes the instance for first use.

parsePattern

protected List<FastDatePrinter.Rule> parsePattern()

Deprecated.

Returns a list of Rules given a pattern.

Returns:

a List of Rule objects

Throws:

IllegalArgumentException - if pattern is invalid

parseToken

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

Deprecated.

Performs the parsing of tokens.

Parameters:

pattern - the pattern

indexRef - index references

Returns:

parsed token

selectNumberRule

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

Deprecated.

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

format

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

Deprecated.

Use {format(Date), {format(Calendar), {format(long), or {format(Object)

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

Specified by:

format in interface DatePrinter

Parameters:

obj - the object to format

toAppendTo - the buffer to append to

pos - the position - ignored

Returns:

the buffer passed in

See Also:

• DateFormat.format(Object, StringBuffer, FieldPosition)

format

String format(Object obj)

Deprecated.

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

Parameters:

obj - the object to format

Returns:

The formatted value.

Since:

3.5

format

public String format(long millis)

Deprecated.

Description copied from interface: DatePrinter

Formats a millisecond long value.

Specified by:

format in interface DatePrinter

Parameters:

millis - the millisecond value to format

Returns:

the formatted string

applyRulesToString

private String applyRulesToString(Calendar c)

Deprecated.

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.

newCalendar

private Calendar newCalendar()

Deprecated.

Creation method for new calendar instances.

Returns:

a new Calendar instance.

format

public String format(Date date)

Deprecated.

Description copied from interface: DatePrinter

Formats a Date object using a GregorianCalendar.

Specified by:

format in interface DatePrinter

Parameters:

date - the date to format

Returns:

the formatted string

format

public String format(Calendar calendar)

Deprecated.

Description copied from interface: DatePrinter

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.

Specified by:

format in interface DatePrinter

Parameters:

calendar - the calendar to format.

Returns:

the formatted string

format

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

Deprecated.

Description copied from interface: DatePrinter

Formats a millisecond long value into the supplied Appendable.

Specified by:

format in interface DatePrinter

Type Parameters:

B - the Appendable class type, usually StringBuilder or StringBuffer.

Parameters:

millis - the millisecond value to format

buf - the buffer to format into

Returns:

the specified string buffer

format

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

Deprecated.

Description copied from interface: DatePrinter

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

Specified by:

format in interface DatePrinter

Type Parameters:

B - the Appendable class type, usually StringBuilder or StringBuffer.

Parameters:

date - the date to format

buf - the buffer to format into

Returns:

the specified string buffer

format

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

Deprecated.

Description copied from interface: DatePrinter

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.

Specified by:

format in interface DatePrinter

Type Parameters:

B - the Appendable class type, usually StringBuilder or StringBuffer.

Parameters:

calendar - the calendar to format

buf - the buffer to format into

Returns:

the specified string buffer

applyRules

@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

applyRules

private <B extends Appendable> B applyRules(Calendar calendar,
 B buf)

Deprecated.

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 format

buf - the buffer to format into

Returns:

the specified string buffer

getPattern

public String getPattern()

Deprecated.

Description copied from interface: DatePrinter

Gets the pattern used by this printer.

Specified by:

getPattern in interface DatePrinter

Returns:

the pattern, SimpleDateFormat compatible

getTimeZone

public TimeZone getTimeZone()

Deprecated.

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 interface DatePrinter

Returns:

the time zone

getLocale

public Locale getLocale()

Deprecated.

Description copied from interface: DatePrinter

Gets the locale used by this printer.

Specified by:

getLocale in interface DatePrinter

Returns:

the locale

getMaxLengthEstimate

public int getMaxLengthEstimate()

Deprecated.

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

public boolean equals(Object obj)

Deprecated.

Compares two objects for equality.

Overrides:

equals in class Object

Parameters:

obj - the object to compare to

Returns:

true if equal

hashCode

public int hashCode()

Deprecated.

Returns a hash code compatible with equals.

Overrides:

hashCode in class Object

Returns:

a hash code compatible with equals

toString

public String toString()

Deprecated.

Gets a debugging string version of this formatter.

Overrides:

toString in class Object

Returns:

a debugging string

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Deprecated.

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

private static void appendDigits(Appendable buffer,
 int value)
                          throws IOException

Deprecated.

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

Deprecated.

Appends all digits to the given buffer.

Parameters:

buffer - the buffer to append to.

value - the value to append digits from.

Throws:

IOException

getTimeZoneDisplay

static String getTimeZoneDisplay(TimeZone tz,
 boolean daylight,
 int style,
 Locale locale)

Deprecated.

Gets the time zone display name, using a cache for performance.

Parameters:

tz - the zone to query

daylight - true if daylight savings

style - the style to use TimeZone.LONG or TimeZone.SHORT

locale - the locale to use

Returns:

the textual name of the time zone