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 ClassesModifier and TypeClassDescriptionprivate final class
private static final class
private static class
private static final class
private static final class
private static final class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final AtomicReference<DatePatternConverter.CachedTime>
private final DatePatternConverter.Formatter
private final String[]
private final ThreadLocal<DatePatternConverter.Formatter>
private final ThreadLocal<MutableInstant>
private static final String
UNIX formatter in seconds (standard).private static final String
UNIX formatter in millisecondsFields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
LOGGER
Fields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter
CATEGORY
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
DatePatternConverter
(String[] options) Private constructor. -
Method Summary
Modifier and TypeMethodDescriptionprivate 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
Gets the pattern string describing this date format.private DatePatternConverter.Formatter
static DatePatternConverter
newInstance
(String[] options) Obtains an instance of pattern converter.Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
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
-
Field Details
-
UNIX_FORMAT
UNIX formatter in seconds (standard).- See Also:
-
UNIX_MILLIS_FORMAT
UNIX formatter in milliseconds- See Also:
-
options
-
threadLocalMutableInstant
-
threadLocalFormatter
-
cachedTime
-
formatter
-
-
Constructor Details
-
DatePatternConverter
Private constructor.- Parameters:
options
- options, may be null.
-
-
Method Details
-
fromEpochMillis
-
createFormatter
-
newInstance
Obtains an instance of pattern converter.- Parameters:
options
- options, may be null.- Returns:
- instance of pattern converter.
-
createFixedFormatter
-
createNonFixedFormatter
-
format
Appends formatted date to string buffer.- Parameters:
date
- datetoAppendTo
- buffer to which formatted date is appended.
-
format
Formats an event into a string buffer.- Specified by:
format
in classLogEventPatternConverter
- 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
-
getMutableInstant
-
format
-
formatWithoutAllocation
-
getThreadLocalFormatter
-
formatWithoutThreadLocals
-
format
Formats an object into a string buffer.- Specified by:
format
in interfacePatternConverter
- Overrides:
format
in classLogEventPatternConverter
- 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
Description copied from interface:ArrayPatternConverter
Formats an array of Objects.- Specified by:
format
in interfaceArrayPatternConverter
- Parameters:
toAppendTo
- The StringBuilder to add the content to.objects
- The Object array.
-
getPattern
Gets the pattern string describing this date format.- Returns:
- the pattern string describing this date format.
-