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
,Log4j1MdcPatternConverter
,Log4j1NdcPatternConverter
,LoggerFqcnPatternConverter
,MapPatternConverter
,MarkerPatternConverter
,MarkerSimpleNamePatternConverter
,MaxLengthConverter
,MdcPatternConverter
,MessagePatternConverter
,MethodLocationPatternConverter
,NamePatternConverter
,NanoTimePatternConverter
,NdcPatternConverter
,ProcessIdPatternConverter
,RegexReplacementConverter
,RelativeTimePatternConverter
,SequenceNumberPatternConverter
,StyleConverter
,ThreadIdPatternConverter
,ThreadNamePatternConverter
,ThreadPriorityPatternConverter
,ThrowablePatternConverter
,UuidPatternConverter
,VariablesNotEmptyReplacementConverter
public abstract class LogEventPatternConverter extends AbstractPatternConverter
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
Constructors Modifier Constructor Description protected
LogEventPatternConverter(String name, String style)
Constructs an instance of LoggingEventPatternConverter.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
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
handlesThrowable()
Normally pattern converters are not meant to handle Exceptions although few pattern converters might.boolean
isVariable()
-
Methods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
getName, getStyleClass
-
-
-
-
Method Detail
-
format
public abstract void format(LogEvent event, StringBuilder toAppendTo)
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
public void format(Object obj, StringBuilder output)
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()
-
-