public class NestableDelegate
extends java.lang.Object
implements java.io.Serializable
A shared implementation of the nestable exception functionality.
The code is shared between
NestableError
,
NestableException
and
NestableRuntimeException
.
Modifier and Type | Field and Description |
---|---|
static boolean |
matchSubclasses
Whether to match subclasses via indexOf.
|
static boolean |
topDown
Whether to print the stack trace top-down.
|
static boolean |
trimStackFrames
Whether to trim the repeated stack trace.
|
Constructor and Description |
---|
NestableDelegate(Nestable nestable)
Constructs a new
NestableDelegate instance to manage the
specified Nestable . |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getMessage(int index)
Returns the error message of the
Throwable in the chain of Throwable s at the
specified index, numbered from 0. |
java.lang.String |
getMessage(java.lang.String baseMsg)
Returns the full message contained by the
Nestable and any nested Throwable s. |
java.lang.String[] |
getMessages()
Returns the error message of this and any nested
Throwable s in an array of Strings, one element
for each message. |
java.lang.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
Throwable s contained in the
Nestable contained by this delegate. |
java.lang.Throwable[] |
getThrowables()
Returns this delegate's
Nestable and any nested
Throwable s in an array of Throwable s, one
element for each Throwable . |
int |
indexOfThrowable(java.lang.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 |
printStackTrace()
Prints the stack trace of this exception the the standar error
stream.
|
void |
printStackTrace(java.io.PrintStream out)
Prints the stack trace of this exception to the specified
stream.
|
void |
printStackTrace(java.io.PrintWriter out)
Prints the stack trace of this exception to the specified
writer.
|
public static boolean topDown
public static boolean trimStackFrames
public static boolean matchSubclasses
public NestableDelegate(Nestable nestable)
NestableDelegate
instance to manage the
specified Nestable
.nestable
- the Nestable implementation (must extend
Throwable
)public java.lang.String getMessage(int index)
Throwable
in the chain of Throwable
s at the
specified index, numbered from 0.index
- the index of the Throwable
in the chain of Throwable
sThrowable
at the specified index in the chain does not
contain a messagejava.lang.IndexOutOfBoundsException
- if the index
argument is negative or not less than the count of Throwable
s
in the chainpublic java.lang.String getMessage(java.lang.String baseMsg)
Nestable
and any nested Throwable
s.baseMsg
- the base message to use when creating the full message. Should be generally be called via
nestableHelper.getMessage(super.getMessage())
, where super
is an
instance of Throwable
.Throwable
spublic java.lang.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
getThrowableCount()
operation.public java.lang.Throwable getThrowable(int index)
Throwable
in the chain of
Throwable
s at the specified index, numbered from 0.index
- the index, numbered from 0, of the Throwable
in
the chain of Throwable
sThrowable
java.lang.IndexOutOfBoundsException
- if the index
argument is
negative or not less than the count of Throwable
s in the
chainpublic int getThrowableCount()
Throwable
s contained in the
Nestable
contained by this delegate.public java.lang.Throwable[] getThrowables()
Nestable
and any nested
Throwable
s in an array of Throwable
s, one
element for each Throwable
.Throwable
spublic int indexOfThrowable(java.lang.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).
An alternative is to use the public static flag matchSubclasses
on NestableDelegate
, however this is not recommended.
type
- the type to find, subclasses match, null returns -1fromIndex
- the index, numbered from 0, of the starting position in
the chain to be searchedjava.lang.IndexOutOfBoundsException
- if the fromIndex
argument
is negative or not less than the count of Throwable
s in the
chainpublic void printStackTrace()
public void printStackTrace(java.io.PrintStream out)
out
- PrintStream
to use for output.printStackTrace(PrintWriter)
public void printStackTrace(java.io.PrintWriter out)
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).out
- PrintWriter
to use for output.Copyright © 2010 - 2020 Adobe. All Rights Reserved