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
FieldsModifier and TypeFieldDescriptionprotected final List<PatternFormatter> ListsPatternFormatters for the suffix attribute.private final booleanprotected final ThrowableFormatOptionsOptions.private Stringprivate final booleanFields inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
LOGGERFields inherited from interface org.apache.logging.log4j.core.pattern.PatternConverter
CATEGORY -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedThrowablePatternConverter(String name, String style, String[] options) Deprecated.Use ThrowablePatternConverter(String name, String stule, String[] options, Configuration config)protectedThrowablePatternConverter(String name, String style, String[] options, Configuration config) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoidformat(LogEvent event, StringBuilder buffer) Formats an event into a string buffer.private voidformatOption(Throwable throwable, String suffix, StringBuilder buffer) private voidformatSubShortOption(Throwable t, String suffix, StringBuilder buffer) protected StringbooleanThis converter obviously handles throwables.static ThrowablePatternConverternewInstance(Configuration config, String[] options) Gets an instance of the class.Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
format, isVariableMethods inherited from class org.apache.logging.log4j.core.pattern.AbstractPatternConverter
getName, getStyleClass
-
Field Details
-
formatters
ListsPatternFormatters for the suffix attribute. -
rawOption
-
subShortOption
private final boolean subShortOption -
nonStandardLineSeparator
private final boolean nonStandardLineSeparator -
options
Options.
-
-
Constructor Details
-
ThrowablePatternConverter
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 Details
-
newInstance
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
Formats an event into a string buffer.- Specified by:
formatin 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.
-
formatSubShortOption
-
formatOption
-
handlesThrowable
public boolean handlesThrowable()This converter obviously handles throwables.- Overrides:
handlesThrowablein classLogEventPatternConverter- Returns:
- true.
-
getSuffix
-
getOptions
-