| java.lang.Object
 org.apache.commons.lang.exception.NestableDelegate
| Field Summary | |
| public static boolean | matchSubclasses
Whether to match subclasses via indexOf. | | public static boolean | topDown
Whether to print the stack trace top-down. | | public static boolean | trimStackFrames
Whether to trim the repeated stack trace. |
| Constructor Summary | |
| public | NestableDelegate(Nestable nestable)
Constructs a new NestableDelegate instance to manage the
specified Nestable. |
| Method Summary | |
| 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 | getMessage(String baseMsg)
Returns the full message contained by the Nestable and any nested Throwables.
Parameters:
baseMsg - the base message to use when creating the full message. | | public String[] | getMessages()
Returns the error message of this and any nested Throwables in an array of Strings, one element
for each message. | | protected String[] | getStackFrames(Throwable t)
Captures the stack trace associated with the specified
Throwable object, decomposing it into a list of
stack frames.
Parameters:
t - The Throwable. | | 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 Throwables contained in the
Nestable contained by this delegate. | | public Throwable[] | getThrowables()
Returns this delegate's Nestable and any nested
Throwables in an array of Throwables, one
element for each Throwable. | | 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 | printStackTrace()
Prints the stack trace of this exception the the standar error
stream. | | public void | printStackTrace(PrintStream out)
Prints the stack trace of this exception to the specified
stream. | | public void | printStackTrace(PrintWriter out)
Prints the stack trace of this exception to the specified
writer. | | protected void | trimStackFrames(List stacks)
Trims the stack frames. |
| matchSubclasses | | public static boolean matchSubclasses(Code) | | Whether to match subclasses via indexOf.
This public flag may be set by calling code, typically in initialisation.
This exists for backwards compatability, setting it to false will return
the library to v2.0 behaviour (but will affect all users of the library
in the classloader).
since:
2.1 |
| topDown | | public static boolean topDown(Code) | | Whether to print the stack trace top-down.
This public flag may be set by calling code, typically in initialisation.
This exists for backwards compatability, setting it to false will return
the library to v1.0 behaviour (but will affect all users of the library
in the classloader).
since:
2.0 |
| trimStackFrames | | public static boolean trimStackFrames(Code) | | Whether to trim the repeated stack trace.
This public flag may be set by calling code, typically in initialisation.
This exists for backwards compatability, setting it to false will return
the library to v1.0 behaviour (but will affect all users of the library
in the classloader).
since:
2.0 |
| NestableDelegate | | public NestableDelegate(Nestable nestable)(Code) | | Constructs a new NestableDelegate instance to manage the
specified Nestable.
Parameters:
nestable - the Nestable implementation (must extendjava.lang.Throwable)
since:
2.0 |
| 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 of Throwables the error message, or null if the Throwable at the specified index in the chain does notcontain a message
throws:
IndexOutOfBoundsException - if the index argument is negative or not less than the count of Throwablesin the chain
since:
2.0 |
| getMessage | | public String getMessage(String baseMsg)(Code) | | Returns the full message contained by the Nestable and any nested Throwables.
Parameters:
baseMsg - the base message to use when creating the full message. Should be generally be called vianestableHelper.getMessage(super.getMessage()), where super is aninstance of java.lang.Throwable. The concatenated message for this and all nested Throwables
since:
2.0 |
| 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
NestableDelegate.getThrowableCount() operation.
the error messages
since:
2.0 |
| getStackFrames | | protected String[] getStackFrames(Throwable t)(Code) | | Captures the stack trace associated with the specified
Throwable object, decomposing it into a list of
stack frames.
Parameters:
t - The Throwable. An array of strings describing each stack frame.
since:
2.0 |
| 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
since:
2.0 |
| getThrowableCount | | public int getThrowableCount()(Code) | | Returns the number of Throwables contained in the
Nestable contained by this delegate.
the throwable count
since:
2.0 |
| getThrowables | | public Throwable[] getThrowables()(Code) | | Returns this delegate's Nestable and any nested
Throwables in an array of Throwables, one
element for each Throwable.
the Throwables
since:
2.0 |
| 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).
An alternative is to use the public static flag
NestableDelegate.matchSubclasses on NestableDelegate, however this is not recommended.
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
since:
2.0 |
| printStackTrace | | public void printStackTrace()(Code) | | Prints the stack trace of this exception the the standar error
stream.
|
| printStackTrace | | public void printStackTrace(PrintWriter out)(Code) | | Prints the stack trace of this exception to the specified
writer. If the Throwable class has a getCause
method (i.e. running on jre1.4 or higher), this method just
uses Throwable's printStackTrace() method. Otherwise, generates
the stack-trace, by taking into account the 'topDown' and
'trimStackFrames' parameters. The topDown and trimStackFrames
are set to 'true' by default (produces jre1.4-like stack trace).
Parameters:
out - PrintWriter to use for output. |
| trimStackFrames | | protected void trimStackFrames(List stacks)(Code) | | Trims the stack frames. The first set is left untouched. The rest
of the frames are truncated from the bottom by comparing with
one just on top.
Parameters:
stacks - The list containing String[] elements
since:
2.0 |
|
|