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 List<PatternFormatter>
formatters
ListsPatternFormatter
s for the suffix attribute.protected ThrowableFormatOptions
options
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, String[] options)
Deprecated.Use ThrowablePatternConverter(String name, String stule, String[] options, Configuration config)protected
ThrowablePatternConverter(String name, String style, String[] options, Configuration config)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
format(LogEvent event, StringBuilder buffer)
Formats an event into a string buffer.ThrowableFormatOptions
getOptions()
protected String
getSuffix(LogEvent event)
boolean
handlesThrowable()
This converter obviously handles throwables.static ThrowablePatternConverter
newInstance(Configuration config, 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
-
-
-
-
Field Detail
-
formatters
protected final List<PatternFormatter> formatters
ListsPatternFormatter
s for the suffix attribute.
-
options
protected final ThrowableFormatOptions options
Options.
-
-
Constructor Detail
-
ThrowablePatternConverter
@Deprecated protected ThrowablePatternConverter(String name, String style, 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(String name, String style, 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, 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 buffer)
Formats an event into a string buffer.- Specified by:
format
in classLogEventPatternConverter
- 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()
This converter obviously handles throwables.- Overrides:
handlesThrowable
in classLogEventPatternConverter
- Returns:
- true.
-
getOptions
public ThrowableFormatOptions getOptions()
-
-