org.apache.avalon.framework.logger

Class AvalonFormatter

public class AvalonFormatter extends ExtendedPatternFormatter

This formatter extends ExtendedPatternFormatter so that CascadingExceptions are formatted with all nested exceptions.

Version: $Id: AvalonFormatter.java 30977 2004-07-30 03:57:54 -0500 (Fri, 30 Jul 2004) niclas $

Author: Avalon Development Team

Field Summary
static booleanDEFAULT_PRINT_CASCADING
The constant defining the default behaviour for printing nested exceptions.
static intDEFAULT_STACK_DEPTH
The constant defining the default stack depth when none other is specified.
booleanm_printCascading
intm_stackDepth
static intTYPE_CLASS
static StringTYPE_CLASS_SHORT_STR
static StringTYPE_CLASS_STR
Constructor Summary
AvalonFormatter(String pattern)
Construct the formatter with the specified pattern and which which prints out exceptions to stackDepth of 8.
AvalonFormatter(String pattern, int stackDepth, boolean printCascading)
Construct the formatter with the specified pattern and which which prints out exceptions to stackDepth specified.
Method Summary
protected StringformatPatternRun(LogEvent event, PatternRun run)
Return the result of formaltting a pattern run.
StringgetClass(String format)
Finds the class that has called Logger.
protected StringgetStackTrace(Throwable throwable, String format)
Utility method to format stack trace.
protected intgetTypeIdFor(String type)
Retrieve the type-id for a particular string.

Field Detail

DEFAULT_PRINT_CASCADING

public static final boolean DEFAULT_PRINT_CASCADING
The constant defining the default behaviour for printing nested exceptions.

Since: 4.1.2

DEFAULT_STACK_DEPTH

public static final int DEFAULT_STACK_DEPTH
The constant defining the default stack depth when none other is specified.

Since: 4.1.2

m_printCascading

private final boolean m_printCascading

m_stackDepth

private final int m_stackDepth

TYPE_CLASS

private static final int TYPE_CLASS

TYPE_CLASS_SHORT_STR

private static final String TYPE_CLASS_SHORT_STR

TYPE_CLASS_STR

private static final String TYPE_CLASS_STR

Constructor Detail

AvalonFormatter

public AvalonFormatter(String pattern)
Construct the formatter with the specified pattern and which which prints out exceptions to stackDepth of 8.

Parameters: pattern The pattern to use to format the log entries

Since: 4.1

AvalonFormatter

public AvalonFormatter(String pattern, int stackDepth, boolean printCascading)
Construct the formatter with the specified pattern and which which prints out exceptions to stackDepth specified.

Parameters: pattern The pattern to use to format the log entries stackDepth The depth to which stacktraces are printed out printCascading true enables printing of nested exceptions, false only prints out the outermost exception

Since: 4.1.2

Method Detail

formatPatternRun

protected String formatPatternRun(LogEvent event, PatternRun run)
Return the result of formaltting a pattern run.

Parameters: event the log event run the patter formatter pattern run

Returns: the formatted string

getClass

private String getClass(String format)
Finds the class that has called Logger.

getStackTrace

protected String getStackTrace(Throwable throwable, String format)
Utility method to format stack trace.

Parameters: throwable the throwable instance format ancilliary format parameter - allowed to be null

Returns: the formatted string

getTypeIdFor

protected int getTypeIdFor(String type)
Retrieve the type-id for a particular string.

Parameters: type the string

Returns: the type-id