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

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

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

Modifier and Type	Method	Description
String	emptyVariableOutput()
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()	Tests whether this pattern converter is renders a Throwable.
boolean	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

Constructor Details

LogEventPatternConverter

protected LogEventPatternConverter(String name,
 String style)

Constructs an instance of LoggingEventPatternConverter.

Parameters:

name - name of converter.

style - CSS style for output.

Method Details

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()

Tests whether this pattern converter is renders a Throwable.

The PatternParser checks this flag when processing the alwaysWriteExceptions option: if no converter in the pattern handles throwables, the parser automatically appends a converter to ensure exceptions are still written.

Returns:

true if this converter consumes and renders a Throwable, false otherwise

isVariable

public boolean isVariable()

emptyVariableOutput

public String emptyVariableOutput()

Returns:

the formatted output when the input variable (MDC, NDC, etc.) is empty