org.apache.logging.log4j.core.pattern

Class PatternFormatter

java.lang.Object

org.apache.logging.log4j.core.pattern.PatternFormatter

public class PatternFormatter
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static PatternFormatter[]	EMPTY_ARRAY The empty array.

Constructor Summary

Constructors

Constructor and Description
PatternFormatter(LogEventPatternConverter converter, FormattingInfo field)

Method Summary

Modifier and Type	Method and Description
void	format(LogEvent event, StringBuilder buf)
LogEventPatternConverter	getConverter()
FormattingInfo	getFormattingInfo()
boolean	handlesThrowable() Normally pattern formatters are not meant to handle Exceptions although few pattern formatters might.
boolean	requiresLocation() Most pattern formatters do not use location information.
String	toString() Returns a String suitable for debugging.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_ARRAY

public static final PatternFormatter[] EMPTY_ARRAY

The empty array.

Constructor Detail

PatternFormatter

public PatternFormatter(LogEventPatternConverter converter,
                        FormattingInfo field)

Method Detail

format

public void format(LogEvent event,
                   StringBuilder buf)

getConverter

public LogEventPatternConverter getConverter()

getFormattingInfo

public FormattingInfo getFormattingInfo()

handlesThrowable

public boolean handlesThrowable()

Normally pattern formatters are not meant to handle Exceptions although few pattern formatters 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

requiresLocation

public boolean requiresLocation()

Most pattern formatters do not use location information. When they do they should return true here so that the logging system can efficiently capture it.

Returns:

true if location information is required.

toString

public String toString()

Returns a String suitable for debugging.

Overrides:

toString in class Object

Returns:

a String suitable for debugging.