Class LogEventPatternConverter
java.lang.Object
org.apache.logging.log4j.core.pattern.AbstractPatternConverter
org.apache.logging.log4j.core.pattern.LogEventPatternConverter
- All Implemented Interfaces:
PatternConverter
- Direct Known Subclasses:
AbstractStyleNameConverter
,DatePatternConverter
,EncodingPatternConverter
,EndOfBatchPatternConverter
,EqualsBaseReplacementConverter
,FileLocationPatternConverter
,FullLocationPatternConverter
,HighlightConverter
,LevelPatternConverter
,LineLocationPatternConverter
,LineSeparatorPatternConverter
,LiteralPatternConverter
,LoggerFqcnPatternConverter
,MapPatternConverter
,MarkerPatternConverter
,MarkerSimpleNamePatternConverter
,MaxLengthConverter
,MdcPatternConverter
,MessagePatternConverter
,MethodLocationPatternConverter
,NamePatternConverter
,NanoTimePatternConverter
,NdcPatternConverter
,ProcessIdPatternConverter
,RegexReplacementConverter
,RelativeTimePatternConverter
,RepeatPatternConverter
,SequenceNumberPatternConverter
,StyleConverter
,ThreadIdPatternConverter
,ThreadNamePatternConverter
,ThreadPriorityPatternConverter
,ThrowablePatternConverter
,UuidPatternConverter
,VariablesNotEmptyReplacementConverter
LoggingEventPatternConverter is a base class for pattern converters
that can format information from instances of LoggingEvent.
-
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
-
Constructor Summary
ModifierConstructorDescriptionprotected
LogEventPatternConverter
(String name, String style) Constructs an instance of LoggingEventPatternConverter. -
Method Summary
Modifier and TypeMethodDescriptionvoid
format
(Object obj, StringBuilder output) Formats an object into a string buffer.abstract void
format
(LogEvent event, StringBuilder toAppendTo) Formats an event into a string buffer.boolean
Normally pattern converters are not meant to handle Exceptions although few pattern converters might.boolean
Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
getName, getStyleClass
-
Constructor Details
-
LogEventPatternConverter
Constructs an instance of LoggingEventPatternConverter.- Parameters:
name
- name of converter.style
- CSS style for output.
-
-
Method Details
-
format
Formats an event into a string buffer.- Parameters:
event
- event to format, may not be null.toAppendTo
- string buffer to which the formatted event will be appended. May not be null.
-
format
Formats an object into a string buffer.- Parameters:
obj
- event to format, may not be null.output
- string buffer to which the formatted event will be appended. May not be null.
-
handlesThrowable
public boolean handlesThrowable()Normally pattern converters are not meant to handle Exceptions although few pattern converters might.By examining the return values for this method, the containing layout will determine whether it handles throwables or not.
- Returns:
- true if this PatternConverter handles throwables
-
isVariable
public boolean isVariable() -
emptyVariableOutput
- Returns:
- the formatted output when the input variable (MDC, NDC, etc.) is empty
-