|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.lang.Throwable java.lang.Exception java.lang.RuntimeException org.apache.commons.lang.exception.NestableRuntimeException
public class NestableRuntimeException
The base class of all runtime exceptions which can contain other exceptions.
NestableException
,
Serialized FormField Summary | |
---|---|
protected NestableDelegate |
delegate
The helper instance which contains much of the code which we delegate to. |
Constructor Summary | |
---|---|
NestableRuntimeException()
Constructs a new NestableRuntimeException without specified
detail message. |
|
NestableRuntimeException(String msg)
Constructs a new NestableRuntimeException with specified
detail message. |
|
NestableRuntimeException(String msg,
Throwable cause)
Constructs a new NestableRuntimeException with specified
detail message and nested Throwable . |
|
NestableRuntimeException(Throwable cause)
Constructs a new NestableRuntimeException with specified
nested Throwable . |
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 detail message string of this throwable. |
String |
getMessage(int index)
Returns the error message of the Throwable in the chain
of Throwable s at the specified index, numbered 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, numbered 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, or a subclass, in the chain of Throwable s. |
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 Throwable s
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()
|
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. |
Methods inherited from class java.lang.Throwable |
---|
fillInStackTrace, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected NestableDelegate delegate
Constructor Detail |
---|
public NestableRuntimeException()
NestableRuntimeException
without specified
detail message.
public NestableRuntimeException(String msg)
NestableRuntimeException
with specified
detail message.
msg
- the error messagepublic NestableRuntimeException(Throwable cause)
NestableRuntimeException
with specified
nested Throwable
.
cause
- the exception or error that caused this exception to be
thrownpublic NestableRuntimeException(String msg, Throwable cause)
NestableRuntimeException
with specified
detail message and nested Throwable
.
msg
- the error messagecause
- the exception or error that caused this exception to be
thrownMethod Detail |
---|
public Throwable getCause()
Nestable
to be thrown.
getCause
in interface Nestable
getCause
in class Throwable
public String getMessage()
getMessage
in interface Nestable
getMessage
in class Throwable
public String getMessage(int index)
Throwable
in the chain
of Throwable
s at the specified index, numbered from 0.
getMessage
in interface Nestable
index
- the index of the Throwable
in the chain of
Throwable
s
Throwable
at the
specified index in the chain does not contain a messagepublic String[] getMessages()
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 Nestable.getThrowableCount()
operation.
getMessages
in interface Nestable
public Throwable getThrowable(int index)
Throwable
in the chain of
Throwable
s at the specified index, numbered from 0.
getThrowable
in interface Nestable
index
- the index, numbered from 0, of the Throwable
in
the chain of Throwable
s
Throwable
public int getThrowableCount()
Throwable
s represented by
this Nestable
, including this Nestable
.
getThrowableCount
in interface Nestable
public Throwable[] getThrowables()
Nestable
and any nested Throwable
s
in an array of Throwable
s, one element for each
Throwable
.
getThrowables
in interface Nestable
Throwable
spublic int indexOfThrowable(Class type)
Throwable
s.
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(Throwable, Class)
(which is avaiable in all versions of lang).
indexOfThrowable
in interface Nestable
type
- the type to find, subclasses match, null returns -1
public int indexOfThrowable(Class type, int fromIndex)
Throwable
that matches the specified type, or a subclass, in the chain of Throwable
s
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(Throwable, Class, int)
(which is avaiable in all versions of lang).
indexOfThrowable
in interface Nestable
type
- the type to find, subclasses match, null returns -1fromIndex
- the index, numbered from 0, of the starting position in
the chain to be searched
public void printStackTrace()
printStackTrace
in class Throwable
public void printStackTrace(PrintStream out)
printStackTrace
in interface Nestable
printStackTrace
in class Throwable
out
- PrintStream
to use for output.public void printStackTrace(PrintWriter out)
printStackTrace
in interface Nestable
printStackTrace
in class Throwable
out
- PrintWriter
to use for output.public final void printPartialStackTrace(PrintWriter out)
NestableDelegate
to write
individual stack traces to a buffer. The implementation of
this method should call
super.printStackTrace(out);
in most cases.
printPartialStackTrace
in interface Nestable
out
- The writer to use.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |