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

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

Outputs certain information extracted from the Throwable associated with a LogEvent.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<PatternFormatter>	formatters	Deprecated. Kept for binary backward compatibility.
protected ThrowableFormatOptions	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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ThrowablePatternConverter(String name, String style, @Nullable String[] options)	Deprecated. Use ThrowablePatternConverter(String, String, String[], Configuration, ThrowablePropertyRendererFactory, ThrowableStackTraceRendererFactory) instead.
protected	ThrowablePatternConverter(String name, String style, @Nullable String[] options, @Nullable Configuration config)	Deprecated. Use ThrowablePatternConverter(String, String, String[], Configuration, ThrowablePropertyRendererFactory, ThrowableStackTraceRendererFactory) instead.

Method Summary

Modifier and Type	Method	Description
void	format(LogEvent event, StringBuilder buffer)	Formats an event into a string buffer.
ThrowableFormatOptions	getOptions()
protected String	getSuffix(LogEvent logEvent)	Deprecated. Planned to be removed without a replacement
boolean	handlesThrowable()	Indicates this converter handles Throwables.
static ThrowablePatternConverter	newInstance(@Nullable Configuration config, @Nullable String[] options)	Creates an instance of the class.

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

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

@Deprecated
protected final List<PatternFormatter> formatters

Deprecated.

Kept for binary backward compatibility.

Returns the list of formatters used to render the suffix.

options

protected final ThrowableFormatOptions options

Constructor Detail

ThrowablePatternConverter

@Deprecated
protected ThrowablePatternConverter(String name,
                                    String style,
                                    @Nullable String[] options)

Deprecated.

Use ThrowablePatternConverter(String, String, String[], Configuration, ThrowablePropertyRendererFactory, ThrowableStackTraceRendererFactory) instead.

ThrowablePatternConverter

@Deprecated
protected ThrowablePatternConverter(String name,
                                    String style,
                                    @Nullable String[] options,
                                    @Nullable Configuration config)

Deprecated.

Use ThrowablePatternConverter(String, String, String[], Configuration, ThrowablePropertyRendererFactory, ThrowableStackTraceRendererFactory) instead.

Method Detail

newInstance

public static ThrowablePatternConverter newInstance(@Nullable Configuration config,
                                                    @Nullable String[] options)

Creates an instance of the class.

Parameters:

config - a configuration

options - the pattern options

Returns:

a new instance

format

public void format(LogEvent event,
                   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.

handlesThrowable

public boolean handlesThrowable()

Indicates this converter handles Throwables.

Overrides:

handlesThrowable in class LogEventPatternConverter

Returns:

true

getOptions

public ThrowableFormatOptions getOptions()

getSuffix

@Deprecated
protected String getSuffix(LogEvent logEvent)

Deprecated.

Planned to be removed without a replacement

Returns the formatted suffix pattern.

Parameters:

logEvent - the log event to use while formatting the suffix pattern

Returns:

the formatted suffix