Package org.apache.logging.log4j.core.pattern

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")
@NullMarked
public final class DatePatternConverter
extends LogEventPatternConverter
implements ArrayPatternConverter

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

Field Summary

Fields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

LOGGER

Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter

CATEGORY

Method Summary

Modifier and Type	Method	Description
void	format(long epochMillis, StringBuilder buffer)	Deprecated. Starting with version 2.25.0, this method is deprecated and planned to be removed in the next major release.
void	format(@Nullable Object object, StringBuilder buffer)	Formats an object into a string buffer.
void	format(StringBuilder buffer, @Nullable Object... objects)	Formats an array of Objects.
void	format(Date date, StringBuilder buffer)	Deprecated. Starting with version 2.25.0, this method is deprecated and planned to be removed in the next major release.
void	format(LogEvent event, StringBuilder output)	Formats an event into a string buffer.
void	format(Instant instant, StringBuilder buffer)	Deprecated. Starting with version 2.25.0, this method is deprecated and planned to be removed in the next major release.
String	getPattern()
TimeZone	getTimeZone()
static DatePatternConverter	newInstance(String[] options)	Obtains an instance of pattern converter.

Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter

emptyVariableOutput, handlesThrowable, isVariable

Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter

getName, getStyleClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter

getName, getStyleClass

Method Detail

newInstance

public static DatePatternConverter newInstance(String[] options)

Obtains an instance of pattern converter.

Parameters:

options - options, may be null.

Returns:

instance of pattern converter.

format

@Deprecated
public void format(Date date,
                   StringBuilder buffer)

Deprecated.

Starting with version 2.25.0, this method is deprecated and planned to be removed in the next major release.

Formats the given date to the provided buffer.

Parameters:

date - a date

buffer - a buffer to append to

format

public void format(LogEvent event,
                   StringBuilder output)

Description copied from class: LogEventPatternConverter

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

@Deprecated
public void format(long epochMillis,
                   StringBuilder buffer)

Deprecated.

Starting with version 2.25.0, this method is deprecated and planned to be removed in the next major release.

Formats the given epoch milliseconds to the provided buffer.

Parameters:

epochMillis - epoch milliseconds

buffer - a buffer to append to

format

@Deprecated
public void format(Instant instant,
                   StringBuilder buffer)

Deprecated.

Starting with version 2.25.0, this method is deprecated and planned to be removed in the next major release.

Formats the given instant to the provided buffer.

Parameters:

instant - an instant

buffer - a buffer to append to

format

public void format(@Nullable Object object,
                   StringBuilder buffer)

Description copied from class: LogEventPatternConverter

Formats an object into a string buffer.

Specified by:

format in interface PatternConverter

Overrides:

format in class LogEventPatternConverter

Parameters:

object - event to format, may not be null.

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

format

public void format(StringBuilder buffer,
                   @Nullable Object... objects)

Description copied from interface: ArrayPatternConverter

Formats an array of Objects.

Specified by:

format in interface ArrayPatternConverter

Parameters:

buffer - The StringBuilder to add the content to.

objects - The Object array.

getPattern

public String getPattern()

Returns:

the pattern string describing this date format or null if the format does not have a pattern.

getTimeZone

public TimeZone getTimeZone()

Returns:

the time zone used by this date format