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

java.lang.Object
  extended by org.apache.logging.log4j.core.pattern.AbstractPatternConverter
      extended by org.apache.logging.log4j.core.pattern.LogEventPatternConverter
          extended by org.apache.logging.log4j.core.pattern.ThrowablePatternConverter
All Implemented Interfaces:
PatternConverter
Direct Known Subclasses:
ExtendedThrowablePatternConverter, RootThrowablePatternConverter

public class ThrowablePatternConverter
extends LogEventPatternConverter

Outputs the Throwable portion of the LoggingEvent as a full stacktrace 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
protected static String FULL
          Format the whole stack trace.
protected  int lines
          The number of lines to write.
protected  String option
          If "short", only first line of throwable report will be formatted.
If "full", the whole stack trace will be formatted.
If "numeric" the output will be limited to the specified number of lines.
protected static String SHORT
          Format only the first line of the throwable.
 
Fields inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
LOGGER
 
Constructor Summary
protected ThrowablePatternConverter(String name, String style, String[] options)
          Constructor.
 
Method Summary
 void format(LogEvent event, StringBuilder toAppendTo)
          Formats an event into a string buffer.
 boolean handlesThrowable()
          This converter obviously handles throwables.
static ThrowablePatternConverter newInstance(String[] options)
          Gets an instance of the class.
 
Methods inherited from class org.apache.logging.log4j.core.pattern.LogEventPatternConverter
format
 
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

FULL

protected static final String FULL
Format the whole stack trace.

See Also:
Constant Field Values

SHORT

protected static final String SHORT
Format only the first line of the throwable.

See Also:
Constant Field Values

option

protected final String option
If "short", only first line of throwable report will be formatted.
If "full", the whole stack trace will be formatted.
If "numeric" the output will be limited to the specified number of lines.


lines

protected final int lines
The number of lines to write.

Constructor Detail

ThrowablePatternConverter

protected ThrowablePatternConverter(String name,
                                    String style,
                                    String[] options)
Constructor.

Parameters:
name - Name of converter.
style - CSS style for output.
options - options, may be null.
Method Detail

newInstance

public static ThrowablePatternConverter newInstance(String[] options)
Gets an instance of the class.

Parameters:
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.

Specified by:
format in class LogEventPatternConverter
Parameters:
event - event to format, may not be null.
toAppendTo - 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 class LogEventPatternConverter
Returns:
true.


Copyright © 1999-2012 Apache Software Foundation. All Rights Reserved.