org.apache.logging.log4j.core.pattern

Class RootThrowablePatternConverter

java.lang.Object

org.apache.logging.log4j.core.pattern.AbstractPatternConverter

org.apache.logging.log4j.core.pattern.LogEventPatternConverter

org.apache.logging.log4j.core.pattern.ThrowablePatternConverter

org.apache.logging.log4j.core.pattern.RootThrowablePatternConverter

All Implemented Interfaces:

PatternConverter

@Plugin(name="RootThrowablePatternConverter",
        category="Converter")
public final class RootThrowablePatternConverter
extends ThrowablePatternConverter

Outputs the Throwable portion of the LoggingEvent as a full stack trace unless this converter's option is 'short', where it just outputs the first line of the trace, or if the number of lines to print is explicitly specified.

The extended stack trace will also include the location of where the class was loaded from and the version of the jar if available.

Field Summary

Fields inherited from class org.apache.logging.log4j.core.pattern.ThrowablePatternConverter

formatters, options

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

Modifier and Type	Method and Description
void	format(LogEvent event, StringBuilder toAppendTo) Formats an event into a string buffer.
static RootThrowablePatternConverter	newInstance(Configuration config, String[] options) Gets an instance of the class.

Methods inherited from class org.apache.logging.log4j.core.pattern.ThrowablePatternConverter

getOptions, getSuffix, handlesThrowable

Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter

format, 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

Method Detail

newInstance

public static RootThrowablePatternConverter newInstance(Configuration config,
                                                        String[] options)

Gets an instance of the class.

Parameters:

config -

options - pattern options, may be null. If first element is "short", only the first line of the throwable will be formatted.

Returns:

instance of class.

format

public void format(LogEvent event,
                   StringBuilder toAppendTo)

Formats an event into a string buffer.

Overrides:

format in class ThrowablePatternConverter

Parameters:

event - event to format, may not be null.

toAppendTo - string buffer to which the formatted event will be appended. May not be null.