org.apache.commons.lang.exception

Interface Nestable

Known Implementing Classes:
NestableError, NestableException, NestableRuntimeException, NotImplementedException, SerializationException, UnhandledException

public interface Nestable

An interface to be implemented by Throwable extensions which would like to be able to nest root exceptions inside themselves.
Version:
$Id: Nestable.java 161243 2005-04-14 04:30:28Z ggregory $
Authors:
Daniel Rall
Kasper Nielsen
Steven Caswell
Pete Gieser
Since:
1.0

Method Summary

Throwable
getCause()
Returns the reference to the exception or error that caused the exception implementing the Nestable to be thrown.
String
getMessage()
Returns the error message of this and any nested Throwable.
String
getMessage(int index)
Returns the error message of the Throwable in the chain of Throwables at the specified index, numbered from 0.
String[]
getMessages()
Returns the error message of this and any nested Throwables in an array of Strings, one element for each message.
Throwable
getThrowable(int index)
Returns the Throwable in the chain of Throwables at the specified index, numbered from 0.
int
getThrowableCount()
Returns the number of nested Throwables represented by this Nestable, including this Nestable.
Throwable[]
getThrowables()
Returns this Nestable and any nested Throwables in an array of Throwables, one element for each Throwable.
int
indexOfThrowable(Class type)
Returns the index, numbered from 0, of the first occurrence of the specified type, or a subclass, in the chain of Throwables.
int
indexOfThrowable(Class type, int fromIndex)
Returns the index, numbered from 0, of the first Throwable that matches the specified type, or a subclass, in the chain of Throwables with an index greater than or equal to the specified index.
void
printPartialStackTrace(PrintWriter out)
Prints the stack trace for this exception only--root cause not included--using the provided writer.
void
printStackTrace(PrintStream out)
Prints the stack trace of this exception to the specified print stream.
void
printStackTrace(PrintWriter out)
Prints the stack trace of this exception to the specified print writer.

Method Details

getCause

public Throwable getCause()
Returns the reference to the exception or error that caused the exception implementing the Nestable to be thrown.
Returns:
throwable that caused the original exception

getMessage

public String getMessage()
Returns the error message of this and any nested Throwable.
Returns:
the error message

getMessage

public String getMessage(int index)
Returns the error message of the Throwable in the chain of Throwables at the specified index, numbered from 0.
Parameters:
index - the index of the Throwable in the chain of Throwables
Returns:
the error message, or null if the Throwable at the specified index in the chain does not contain a message

getMessages

public String[] getMessages()
Returns:
the error messages

getThrowable

public Throwable getThrowable(int index)
Returns the Throwable in the chain of Throwables at the specified index, numbered from 0.
Parameters:
index - the index, numbered from 0, of the Throwable in the chain of Throwables
Returns:
the Throwable

getThrowableCount

public int getThrowableCount()
Returns the number of nested Throwables represented by this Nestable, including this Nestable.
Returns:
the throwable count

getThrowables

public Throwable[] getThrowables()
Returns this Nestable and any nested Throwables in an array of Throwables, one element for each Throwable.
Returns:
the Throwables

indexOfThrowable

public int indexOfThrowable(Class type)
Parameters:
type - the type to find, subclasses match, null returns -1
Returns:
index of the first occurrence of the type in the chain, or -1 if the type is not found

indexOfThrowable

public int indexOfThrowable(Class type,
                            int fromIndex)
Parameters:
type - the type to find, subclasses match, null returns -1
fromIndex - the index, numbered from 0, of the starting position in the chain to be searched
Returns:
index of the first occurrence of the type in the chain, or -1 if the type is not found

printPartialStackTrace

public void printPartialStackTrace(PrintWriter out)
Prints the stack trace for this exception only--root cause not included--using the provided writer. Used by NestableDelegate to write individual stack traces to a buffer. The implementation of this method should call super.printStackTrace(out); in most cases.
Parameters:
out - The writer to use.

printStackTrace

public void printStackTrace(PrintStream out)
Prints the stack trace of this exception to the specified print stream. Includes information from the exception, if any, which caused this exception.
Parameters:
out - PrintStream to use for output.

printStackTrace

public void printStackTrace(PrintWriter out)
Prints the stack trace of this exception to the specified print writer. Includes information from the exception, if any, which caused this exception.
Parameters:
out - PrintWriter to use for output.

Copyright © 2001-2005 - Apache Software Foundation