Class DatePatternConverter

java.lang.Object

org.apache.logging.log4j.core.pattern.AbstractPatternConverter

org.apache.logging.log4j.core.pattern.LogEventPatternConverter

org.apache.logging.log4j.core.pattern.DatePatternConverter

All Implemented Interfaces:

ArrayPatternConverter, PatternConverter

@Plugin(name="DatePatternConverter",
        category="Converter")
public final class DatePatternConverter
extends LogEventPatternConverter
implements ArrayPatternConverter

Converts and formats the event's date in a StringBuilder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	DatePatternConverter.CachedTime
private static final class	DatePatternConverter.FixedFormatter
private static class	DatePatternConverter.Formatter
private static final class	DatePatternConverter.PatternFormatter
private static final class	DatePatternConverter.UnixFormatter
private static final class	DatePatternConverter.UnixMillisFormatter

Field Summary

Fields

Modifier and Type	Field	Description
private final AtomicReference<DatePatternConverter.CachedTime>	cachedTime
private final DatePatternConverter.Formatter	formatter
private final String[]	options
private final ThreadLocal<DatePatternConverter.Formatter>	threadLocalFormatter
private final ThreadLocal<MutableInstant>	threadLocalMutableInstant
private static final String	UNIX_FORMAT	UNIX formatter in seconds (standard).
private static final String	UNIX_MILLIS_FORMAT	UNIX formatter in milliseconds

Fields inherited from class AbstractPatternConverter

LOGGER

Fields inherited from interface PatternConverter

CATEGORY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DatePatternConverter(String[] options)	Private constructor.

Method Summary

Modifier and Type	Method	Description
private static DatePatternConverter.Formatter	createFixedFormatter(FixedDateFormat fixedDateFormat)
private DatePatternConverter.Formatter	createFormatter(String[] options)
private static DatePatternConverter.Formatter	createNonFixedFormatter(String[] options)
void	format(long epochMilli, StringBuilder output)
void	format(Object obj, StringBuilder output)	Formats an object into a string buffer.
void	format(StringBuilder toAppendTo, Object... objects)	Formats an array of Objects.
void	format(Date date, StringBuilder toAppendTo)	Appends formatted date to string buffer.
void	format(LogEvent event, StringBuilder output)	Formats an event into a string buffer.
void	format(Instant instant, StringBuilder output)
private void	formatWithoutAllocation(Instant instant, StringBuilder output)
private void	formatWithoutThreadLocals(Instant instant, StringBuilder output)
private DatePatternConverter.CachedTime	fromEpochMillis(long epochMillis)
private MutableInstant	getMutableInstant()
String	getPattern()	Gets the pattern string describing this date format.
private DatePatternConverter.Formatter	getThreadLocalFormatter()
TimeZone	getTimeZone()	Gets the timezone used by this date format.
static DatePatternConverter	newInstance(String[] options)	Obtains an instance of pattern converter.

Methods inherited from class LogEventPatternConverter

handlesThrowable, isVariable

Methods inherited from class AbstractPatternConverter

getName, getStyleClass

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface PatternConverter

getName, getStyleClass

Field Details

UNIX_FORMAT

private static final String UNIX_FORMAT

UNIX formatter in seconds (standard).

See Also:

• Constant Field Values

UNIX_MILLIS_FORMAT

private static final String UNIX_MILLIS_FORMAT

UNIX formatter in milliseconds

See Also:

• Constant Field Values

options

private final String[] options

threadLocalMutableInstant

private final ThreadLocal<MutableInstant> threadLocalMutableInstant

threadLocalFormatter

private final ThreadLocal<DatePatternConverter.Formatter> threadLocalFormatter

cachedTime

private final AtomicReference<DatePatternConverter.CachedTime> cachedTime

formatter

private final DatePatternConverter.Formatter formatter

Constructor Details

DatePatternConverter

private DatePatternConverter(String[] options)

Private constructor.

Parameters:

options - options, may be null.

Method Details

fromEpochMillis

private DatePatternConverter.CachedTime fromEpochMillis(long epochMillis)

createFormatter

private DatePatternConverter.Formatter createFormatter(String[] options)

newInstance

public static DatePatternConverter newInstance(String[] options)

Obtains an instance of pattern converter.

Parameters:

options - options, may be null.

Returns:

instance of pattern converter.

createFixedFormatter

private static DatePatternConverter.Formatter createFixedFormatter(FixedDateFormat fixedDateFormat)

createNonFixedFormatter

private static DatePatternConverter.Formatter createNonFixedFormatter(String[] options)

format

public void format(Date date,
 StringBuilder toAppendTo)

Appends formatted date to string buffer.

Parameters:

date - date

toAppendTo - buffer to which formatted date is appended.

format

public void format(LogEvent event,
 StringBuilder output)

Formats an event into a string buffer.

Specified by:

format in class LogEventPatternConverter

Parameters:

event - event to format, may not be null.

output - string buffer to which the formatted event will be appended. May not be null.

format

public void format(long epochMilli,
 StringBuilder output)

getMutableInstant

private MutableInstant getMutableInstant()

format

public void format(Instant instant,
 StringBuilder output)

formatWithoutAllocation

private void formatWithoutAllocation(Instant instant,
 StringBuilder output)

getThreadLocalFormatter

private DatePatternConverter.Formatter getThreadLocalFormatter()

formatWithoutThreadLocals

private void formatWithoutThreadLocals(Instant instant,
 StringBuilder output)

format

public void format(Object obj,
 StringBuilder output)

Formats an object into a string buffer.

Specified by:

format in interface PatternConverter

Overrides:

format in class LogEventPatternConverter

Parameters:

obj - event to format, may not be null.

output - string buffer to which the formatted event will be appended. May not be null.

format

public void format(StringBuilder toAppendTo,
 Object... objects)

Description copied from interface: ArrayPatternConverter

Formats an array of Objects.

Specified by:

format in interface ArrayPatternConverter

Parameters:

toAppendTo - The StringBuilder to add the content to.

objects - The Object array.

getPattern

public String getPattern()

Gets the pattern string describing this date format.

Returns:

the pattern string describing this date format.

getTimeZone

public TimeZone getTimeZone()

Gets the timezone used by this date format.

Returns:

the timezone used by this date format.