Package org.apache.avalon.framework

Class ExceptionUtil

java.lang.Object

org.apache.avalon.framework.ExceptionUtil

public final class ExceptionUtil
extends java.lang.Object

This class provides basic facilities for manipulating exceptions. Some exception handling stuff thieved from Turbine...

Author:

Avalon Development Team

Field Summary

Fields

Modifier and Type	Field	Description
private static java.lang.String	GET_CAUSE_NAME
private static java.lang.Class[]	GET_CAUSE_PARAMTYPES
private static java.lang.String	LINE_SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ExceptionUtil()	Private constructor to prevent instantiation.

Method Summary

Modifier and Type	Method	Description
static java.lang.String[]	captureStackTrace(java.lang.Throwable throwable)	Captures the stack trace associated with this exception.
static java.lang.Throwable	getCause(java.lang.Throwable throwable, boolean useReflection)	Utility method to get cause of exception.
static java.lang.String	printStackTrace(java.lang.Throwable throwable)	Generate string for specified exception and the cause of this exception (if any).
static java.lang.String	printStackTrace(java.lang.Throwable throwable, boolean printCascading)	Generate string for specified exception and if printCascading is true will print all cascading exceptions.
static java.lang.String	printStackTrace(java.lang.Throwable throwable, int depth)	Serialize the specified Throwable to a string.
static java.lang.String	printStackTrace(java.lang.Throwable throwable, int depth, boolean printCascading)	Generate exception string for specified exception to specified depth and all Cascading exceptions if printCascading is true.
static java.lang.String	printStackTrace(java.lang.Throwable throwable, int depth, boolean printCascading, boolean useReflection)	Generate exception string for specified exception to specified depth and all Cascading exceptions if printCascading is true.
static java.lang.String[]	splitString(java.lang.String string, java.lang.String onToken)	Deprecated. This is an internal utility method that should not be used
private static java.lang.String[]	splitStringInternal(java.lang.String string, java.lang.String onToken)	Splits the string on every token into an array of stack frames.

Methods inherited from class java.lang.Object

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

Field Detail

LINE_SEPARATOR

private static final java.lang.String LINE_SEPARATOR

GET_CAUSE_NAME

private static final java.lang.String GET_CAUSE_NAME

See Also:

Constant Field Values

GET_CAUSE_PARAMTYPES

private static final java.lang.Class[] GET_CAUSE_PARAMTYPES

Constructor Detail

ExceptionUtil

private ExceptionUtil()

Private constructor to prevent instantiation.

Method Detail

printStackTrace

public static java.lang.String printStackTrace(java.lang.Throwable throwable)

Generate string for specified exception and the cause of this exception (if any).

Parameters:

throwable - a Throwable

Returns:

the stack trace as a String

printStackTrace

public static java.lang.String printStackTrace(java.lang.Throwable throwable,
                                               boolean printCascading)

Generate string for specified exception and if printCascading is true will print all cascading exceptions.

Parameters:

throwable - a Throwable

printCascading - if true will print all cascading exceptions

Returns:

the stack trace as a String

printStackTrace

public static java.lang.String printStackTrace(java.lang.Throwable throwable,
                                               int depth)

Serialize the specified Throwable to a string. Restrict the number of frames printed out to the specified depth. If the depth specified is 0 then all the frames are converted into a string.

Parameters:

throwable - a Throwable

depth - number of stack trace frames to show

Returns:

the stack trace as a String

printStackTrace

public static java.lang.String printStackTrace(java.lang.Throwable throwable,
                                               int depth,
                                               boolean printCascading)

Generate exception string for specified exception to specified depth and all Cascading exceptions if printCascading is true.

Parameters:

throwable - a Throwable

depth - number of stack trace frames to show

printCascading - if true will print all cascading exceptions

Returns:

the stack trace as a String

printStackTrace

public static java.lang.String printStackTrace(java.lang.Throwable throwable,
                                               int depth,
                                               boolean printCascading,
                                               boolean useReflection)

Generate exception string for specified exception to specified depth and all Cascading exceptions if printCascading is true. If useReflection is true then the method will also attempt to use reflection to find a method with signature Throwable getCause(). This makes it compatible with JDK1.4 mechanisms for nesting exceptions.

Parameters:

throwable - a Throwable

depth - number of stack trace frames to show

printCascading - if true will print all cascading exceptions

useReflection - if true will use reflection to handle JDK1.4 nested exceptions

Returns:

the stack trace as a String

getCause

public static java.lang.Throwable getCause(java.lang.Throwable throwable,
                                           boolean useReflection)

Utility method to get cause of exception.

Parameters:

throwable - a Throwable

useReflection - if true will use reflection to handle JDK1.4 nested exceptions

Returns:

cause of specified exception

captureStackTrace

public static java.lang.String[] captureStackTrace(java.lang.Throwable throwable)

Captures the stack trace associated with this exception.

Parameters:

throwable - a Throwable

Returns:

an array of Strings describing stack frames.

splitString

public static java.lang.String[] splitString(java.lang.String string,
                                             java.lang.String onToken)

Deprecated.

This is an internal utility method that should not be used

Splits the string on every token into an array of stack frames.

Parameters:

string - the string to split

onToken - the token to split on

Returns:

the resultant array

splitStringInternal

private static java.lang.String[] splitStringInternal(java.lang.String string,
                                                      java.lang.String onToken)

Splits the string on every token into an array of stack frames.

Parameters:

string - the string to split

onToken - the token to split on

Returns:

the resultant array