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.
-
-
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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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)
String
getPattern()
Gets the pattern string describing this date format.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
-
-
-
-
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
public void format(Date date, StringBuilder toAppendTo)
Appends formatted date to string buffer.- Parameters:
date
- datetoAppendTo
- 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 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
public void format(long epochMilli, StringBuilder output)
-
format
public void format(Instant instant, StringBuilder output)
-
format
public void format(Object obj, StringBuilder output)
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
public void format(StringBuilder toAppendTo, Object... objects)
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
public String getPattern()
Gets the pattern string describing this date format.- Returns:
- the pattern string describing this date format.
-
-