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

Class ThrowablePatternConverter

java.lang.Object

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

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

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

All Implemented Interfaces:

PatternConverter

Direct Known Subclasses:

ExtendedThrowablePatternConverter, RootThrowablePatternConverter

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

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.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<PatternFormatter>	formatters	Lists PatternFormatters for the suffix attribute.
private boolean	nonStandardLineSeparator
protected ThrowableFormatOptions	options	Options.
private java.lang.String	rawOption
private boolean	subShortOption

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	ThrowablePatternConverter(java.lang.String name, java.lang.String style, java.lang.String[] options)	Deprecated. Use ThrowablePatternConverter(String name, String stule, String[] options, Configuration config)
protected	ThrowablePatternConverter(java.lang.String name, java.lang.String style, java.lang.String[] options, Configuration config)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	format(LogEvent event, java.lang.StringBuilder buffer)	Formats an event into a string buffer.
private void	formatOption(java.lang.Throwable throwable, java.lang.String suffix, java.lang.StringBuilder buffer)
private void	formatSubShortOption(java.lang.Throwable t, java.lang.String suffix, java.lang.StringBuilder buffer)
ThrowableFormatOptions	getOptions()
protected java.lang.String	getSuffix(LogEvent event)
boolean	handlesThrowable()	This converter obviously handles throwables.
static ThrowablePatternConverter	newInstance(Configuration config, java.lang.String[] options)	Gets an instance of the class.

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

Field Detail

formatters

protected final java.util.List<PatternFormatter> formatters

Lists PatternFormatters for the suffix attribute.

rawOption

private java.lang.String rawOption

subShortOption

private final boolean subShortOption

nonStandardLineSeparator

private final boolean nonStandardLineSeparator

options

protected final ThrowableFormatOptions options

Options.

Constructor Detail

ThrowablePatternConverter

@Deprecated
protected ThrowablePatternConverter(java.lang.String name,
                                    java.lang.String style,
                                    java.lang.String[] options)

Deprecated.

Use ThrowablePatternConverter(String name, String stule, String[] options, Configuration config)

Constructor.

Parameters:

name - Name of converter.

style - CSS style for output.

options - options, may be null.

ThrowablePatternConverter

protected ThrowablePatternConverter(java.lang.String name,
                                    java.lang.String style,
                                    java.lang.String[] options,
                                    Configuration config)

Constructor.

Parameters:

name - Name of converter.

style - CSS style for output.

options - options, may be null.

config -

Method Detail

newInstance

public static ThrowablePatternConverter newInstance(Configuration config,
                                                    java.lang.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,
                   java.lang.StringBuilder buffer)

Formats an event into a string buffer.

Specified by:

format in class LogEventPatternConverter

Parameters:

event - event to format, may not be null.

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

formatSubShortOption

private void formatSubShortOption(java.lang.Throwable t,
                                  java.lang.String suffix,
                                  java.lang.StringBuilder buffer)

formatOption

private void formatOption(java.lang.Throwable throwable,
                          java.lang.String suffix,
                          java.lang.StringBuilder buffer)

handlesThrowable

public boolean handlesThrowable()

This converter obviously handles throwables.

Overrides:

handlesThrowable in class LogEventPatternConverter

Returns:

true.

getSuffix

protected java.lang.String getSuffix(LogEvent event)

getOptions

public ThrowableFormatOptions getOptions()