| org.apache.commons.lang.exception.Nestable
All known Subclasses: org.apache.commons.lang.exception.NestableException, org.apache.commons.lang.NotImplementedException, org.apache.commons.lang.exception.NestableRuntimeException, org.apache.commons.lang.exception.NestableError,
| Nestable | | public interface Nestable (Code) | | An interface to be implemented by
java.lang.Throwable extensions which would like to be able to nest root exceptions
inside themselves.
author:
Daniel Rall
author:
Kasper Nielsen
author:
Steven Caswell
author:
Pete Gieser
since:
1.0
version:
$Id: Nestable.java 437554 2006-08-28 06:21:41Z bayard $ |
| Method Summary | |
| public Throwable | getCause()
Returns the reference to the exception or error that caused the
exception implementing the Nestable to be thrown. | | public String | getMessage()
Returns the error message of this and any nested
Throwable. | | public String | getMessage(int index)
Returns the error message of the Throwable in the chain
of Throwables at the specified index, numbered from 0. | | public String[] | getMessages()
Returns the error message of this and any nested Throwables
in an array of Strings, one element for each message. | | public Throwable | getThrowable(int index)
Returns the Throwable in the chain of
Throwables at the specified index, numbered from 0. | | public int | getThrowableCount()
Returns the number of nested Throwables represented by
this Nestable, including this Nestable. | | public Throwable[] | getThrowables()
Returns this Nestable and any nested Throwables
in an array of Throwables, one element for each
Throwable. | | public 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. | | public 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. | | public void | printPartialStackTrace(PrintWriter out)
Prints the stack trace for this exception only--root cause not
included--using the provided writer. | | public void | printStackTrace(PrintWriter out)
Prints the stack trace of this exception to the specified print
writer. | | public void | printStackTrace(PrintStream out)
Prints the stack trace of this exception to the specified print
stream. |
| getCause | | public Throwable getCause()(Code) | | Returns the reference to the exception or error that caused the
exception implementing the Nestable to be thrown.
throwable that caused the original exception |
| getMessage | | public String getMessage()(Code) | | Returns the error message of this and any nested
Throwable.
the error message |
| getMessage | | public String getMessage(int index)(Code) | | 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 ofThrowables the error message, or null if the Throwable at thespecified index in the chain does not contain a message
throws:
IndexOutOfBoundsException - if the index argument isnegative or not less than the count of Throwables in thechain |
| getMessages | | public String[] getMessages()(Code) | | Returns the error message of this and any nested Throwables
in an array of Strings, one element for each message. Any
Throwable not containing a message is represented in the
array by a null. This has the effect of cause the length of the returned
array to be equal to the result of the
Nestable.getThrowableCount() operation.
the error messages |
| getThrowable | | public Throwable getThrowable(int index)(Code) | | 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 inthe chain of Throwables the Throwable
throws:
IndexOutOfBoundsException - if the index argument isnegative or not less than the count of Throwables in thechain |
| getThrowableCount | | public int getThrowableCount()(Code) | | Returns the number of nested Throwables represented by
this Nestable, including this Nestable.
the throwable count |
| getThrowables | | public Throwable[] getThrowables()(Code) | | Returns this Nestable and any nested Throwables
in an array of Throwables, one element for each
Throwable.
the Throwables |
| indexOfThrowable | | public int indexOfThrowable(Class type)(Code) | | Returns the index, numbered from 0, of the first occurrence of the
specified type, or a subclass, in the chain of Throwables.
The method returns -1 if the specified type is not found in the chain.
NOTE: From v2.1, we have clarified the Nestable interface
such that this method matches subclasses.
If you want to NOT match subclasses, please use
ExceptionUtils.indexOfThrowable(ThrowableClass) (which is avaiable in all versions of lang).
Parameters:
type - the type to find, subclasses match, null returns -1 index of the first occurrence of the type in the chain, or -1 ifthe type is not found |
| indexOfThrowable | | public int indexOfThrowable(Class type, int fromIndex)(Code) | | 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.
The method returns -1 if the specified type is not found in the chain.
NOTE: From v2.1, we have clarified the Nestable interface
such that this method matches subclasses.
If you want to NOT match subclasses, please use
ExceptionUtils.indexOfThrowable(ThrowableClassint) (which is avaiable in all versions of lang).
Parameters:
type - the type to find, subclasses match, null returns -1
Parameters:
fromIndex - the index, numbered from 0, of the starting position inthe chain to be searched index of the first occurrence of the type in the chain, or -1 ifthe type is not found
throws:
IndexOutOfBoundsException - if the fromIndex argumentis negative or not less than the count of Throwables in thechain |
| printPartialStackTrace | | public void printPartialStackTrace(PrintWriter out)(Code) | | Prints the stack trace for this exception only--root cause not
included--using the provided writer. Used by
org.apache.commons.lang.exception.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(PrintWriter out)(Code) | | 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. |
| printStackTrace | | public void printStackTrace(PrintStream out)(Code) | | 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. |
|
|