org.apache.commons.lang.exception
Interface Nestable
- NestableError, NestableException, NestableRuntimeException, SerializationException, UnhandledException
public interface Nestable
An interface to be implemented by java.lang.Throwable
extensions which would like to be able to nest root exceptions
inside themselves.
Version:
- Daniel Rall
- Kasper Nielsen
- Steven Caswell
- Pete Gieser
- 1.0
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 Throwable s at the specified index, numbererd from 0.
|
String[] | getMessages() - Returns the error message of this and any nested
Throwable s
in an array of Strings, one element for each message.
|
Throwable | getThrowable(int index) - Returns the
Throwable in the chain of
Throwable s at the specified index, numbererd from 0.
|
int | getThrowableCount() - Returns the number of nested
Throwable s represented by
this Nestable , including this Nestable .
|
Throwable[] | getThrowables() - Returns this
Nestable and any nested Throwable s
in an array of Throwable s, one element for each
Throwable .
|
int | indexOfThrowable(Class type) - Returns the index, numbered from 0, of the first occurrence of the
specified type in the chain of
Throwable s, or -1 if the
specified type is not found in the chain.
|
int | indexOfThrowable(Class type, int fromIndex) - Returns the index, numbered from 0, of the first
Throwable
that matches the specified type in the chain of Throwable s
with an index greater than or equal to the specified index, or -1 if
the type is not found.
|
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.
|
getCause
public Throwable getCause()
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()
Returns the error message of this and any nested
Throwable
.
- the error message
getMessage
public String getMessage(int index)
Returns the error message of the Throwable
in the chain
of Throwable
s at the specified index, numbererd from 0.
index
- the index of the Throwable
in the chain of
Throwable
s
- 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 message of this and any nested
Throwable
s
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
getThrowableCount()
operation.
- the error messages
getThrowable
public Throwable getThrowable(int index)
Returns the Throwable
in the chain of
Throwable
s at the specified index, numbererd from 0.
index
- the index, numbered from 0, of the Throwable
in
the chain of Throwable
s
- the
Throwable
getThrowableCount
public int getThrowableCount()
Returns the number of nested Throwable
s represented by
this Nestable
, including this Nestable
.
- the throwable count
getThrowables
public Throwable[] getThrowables()
Returns this Nestable
and any nested Throwable
s
in an array of Throwable
s, one element for each
Throwable
.
- the
Throwable
s
indexOfThrowable
public int indexOfThrowable(Class type)
Returns the index, numbered from 0, of the first occurrence of the
specified type in the chain of Throwable
s, or -1 if the
specified type is not found in the chain.
type
- Class
to be found
- 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)
Returns the index, numbered from 0, of the first Throwable
that matches the specified type in the chain of Throwable
s
with an index greater than or equal to the specified index, or -1 if
the type is not found.
type
- Class
to be foundfromIndex
- the index, numbered from 0, of the starting position in
the chain to be searched
- 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.
out
- The writer to use.
printStackTrace
public void printStackTrace(PrintStream out)
Prints the stack trace of this exception to the specified print
stream. Includes inforamation from the exception, if any,
which caused this exception.
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.
out
- PrintWriter
to use for output.
Copyright © 2001-2003 - Apache Software Foundation