com.virtuosotechnologies.lib.error
Class StackTraceExceptionFormatter

java.lang.Object
  com.virtuosotechnologies.lib.error.StackTraceExceptionFormatter

All Implemented Interfaces:

ExceptionFormatter

public class StackTraceExceptionFormatter

extends Object

implements ExceptionFormatter

Exception formatter that creates full stack traces. This uses two templates, both MessageFormat patterns.

The exception template accepts the following parameters:

• 0 reserved (set to the empty string)
• 1 the fully-qualified classname for the exception
• 2 1 if there is a message, or 0 if not. Used in ChoiceFormat subpatterns.
• 3 the message string, or the empty string if there is no message.
• 4 0 if this is the outermost exception, or 1 if it is a cause. Used in ChoiceFormat subpatterns.
• 5 1 if this exception has a cause, or 0 if not. Used in ChoiceFormat subpatterns.

The stack trace element template accepts the following parameters:

• 0 reserved (set to the empty string)
• 1 0 if the trace point is a native method, 1 if it's in java source but there is no location info, 2 if the source file name is available but not the line number, 3 if all info is available. Used in ChoiceFormat subpatterns.
• 2 the source file name, or the empty string if it is not available
• 3 the source file line number, or an unspecified negative value if it is not available
• 4 the fully-qualified class name for the trace point
• 5 the method name containing the trace point
• 6 the element number, counting up (e.g. the first element is 0).
• 7 the element number, counting down (e.g. the last element is 0).

This class is fully synchronized and thread-safe.

Constructor Summary

StackTraceExceptionFormatter()
Construct a formatter using the default templates

Method Summary

String	format(Throwable ex, PropertySet properties) Generate a String representation of the given exception.
void	setExceptionTemplate(String template) Set the template for exceptions
void	setStackTraceElementTemplate(String template) Set the template for stack trace elements

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StackTraceExceptionFormatter

public StackTraceExceptionFormatter()

Construct a formatter using the default templates

Method Detail

setExceptionTemplate

public void setExceptionTemplate(String template)

Set the template for exceptions

Parameters:

template - new template String

setStackTraceElementTemplate

public void setStackTraceElementTemplate(String template)

Set the template for stack trace elements

Parameters:

template - new template String

format

public String format(Throwable ex,
                     PropertySet properties)

Generate a String representation of the given exception.

Specified by:

format in interface ExceptionFormatter

Parameters:

ex - throwable

properties - formatter-specific properties.

Returns:

a formatted String.