org.apache.commons.lang.exception
クラス NestableDelegate

java.lang.Object
  org.apache.commons.lang.exception.NestableDelegate

すべての実装インタフェース:

Serializable

public class NestableDelegate

extends Object

implements Serializable

A shared implementation of the nestable exception functionality.

The code is shared between NestableError, NestableException and NestableRuntimeException.

導入されたバージョン:

1.0

バージョン:

$Id: NestableDelegate.java,v 1.1.1.1 2004/02/13 10:02:06 hioki Exp $

作成者:

Rafal Krzewski, Daniel Rall, Kasper Nielsen, Steven Caswell, Sean C. Sullivan, Stephen Colebourne

関連項目:

直列化された形式

フィールドの概要

static boolean	topDown Whether to print the stack trace top-down.
static boolean	trimStackFrames Whether to trim the repeated stack trace.

コンストラクタの概要

NestableDelegate(Nestable nestable)
Constructs a new NestableDelegate instance to manage the specified Nestable.

メソッドの概要

String	getMessage(int index) Returns the error message of the Throwable in the chain of Throwables at the specified index, numbererd from 0.
String	getMessage(String baseMsg) Returns the full message contained by the Nestable and any nested Throwables.
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.
Throwable	getThrowable(int index) Returns the Throwable in the chain of Throwables at the specified index, numbererd from 0.
int	getThrowableCount() Returns the number of Throwables contained in the Nestable contained by this delegate.
Throwable[]	getThrowables() Returns this delegate's Nestable and any nested Throwables in an array of Throwables, one element for each Throwable.
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 Throwables held in this delegate's Nestable with an index greater than or equal to the specified index, or -1 if the type is not found.
void	printStackTrace() Prints the stack trace of this exception the the standar error stream.
void	printStackTrace(PrintStream out) Prints the stack trace of this exception to the specified stream.
void	printStackTrace(PrintWriter out) Prints the stack trace of this exception to the specified writer.
protected void	trimStackFrames(List stacks) Trims the stack frames.

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

topDown

public static boolean topDown

Whether to print the stack trace top-down. This public flag may be set by calling code, typically in initialisation.

導入されたバージョン:

2.0

trimStackFrames

public static boolean trimStackFrames

Whether to trim the repeated stack trace. This public flag may be set by calling code, typically in initialisation.

導入されたバージョン:

2.0

コンストラクタの詳細

NestableDelegate

public NestableDelegate(Nestable nestable)

Constructs a new NestableDelegate instance to manage the specified Nestable.

パラメータ:

nestable - the Nestable implementation (must extend Throwable)

導入されたバージョン:

2.0

メソッドの詳細

getMessage

public String getMessage(int index)

Returns the error message of the Throwable in the chain of Throwables at the specified index, numbererd from 0.

パラメータ:

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 not contain a message

例外:

IndexOutOfBoundsException - if the index argument is negative or not less than the count of Throwables in the chain

導入されたバージョン:

2.0

getMessage

public String getMessage(String baseMsg)

Returns the full message contained by the Nestable and any nested Throwables.

パラメータ:

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.

戻り値:

The concatenated message for this and all nested Throwables

導入されたバージョン:

2.0

getMessages

public String[] getMessages()

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 getThrowableCount() operation.

戻り値:

the error messages

導入されたバージョン:

2.0

getThrowable

public Throwable getThrowable(int index)

Returns the Throwable in the chain of Throwables at the specified index, numbererd from 0.

パラメータ:

index - the index, numbered from 0, of the Throwable in the chain of Throwables

戻り値:

the Throwable

例外:

IndexOutOfBoundsException - if the index argument is negative or not less than the count of Throwables in the chain

導入されたバージョン:

2.0

getThrowableCount

public int getThrowableCount()

Returns the number of Throwables contained in the Nestable contained by this delegate.

戻り値:

the throwable count

導入されたバージョン:

2.0

getThrowables

public Throwable[] getThrowables()

Returns this delegate's Nestable and any nested Throwables in an array of Throwables, one element for each Throwable.

戻り値:

the Throwables

導入されたバージョン:

2.0

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 Throwables held in this delegate's Nestable with an index greater than or equal to the specified index, or -1 if the type is not found.

パラメータ:

type - Class to be found

fromIndex - 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

例外:

IndexOutOfBoundsException - if the fromIndex argument is negative or not less than the count of Throwables in the chain

導入されたバージョン:

2.0

printStackTrace

public void printStackTrace()

Prints the stack trace of this exception the the standar error stream.

printStackTrace

public void printStackTrace(PrintStream out)

Prints the stack trace of this exception to the specified stream.

パラメータ:

out - PrintStream to use for output.

関連項目:

printStackTrace(PrintWriter)

printStackTrace

public void printStackTrace(PrintWriter out)

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).

パラメータ:

out - PrintWriter to use for output.

getStackFrames

protected String[] getStackFrames(Throwable t)

Captures the stack trace associated with the specified Throwable object, decomposing it into a list of stack frames.

パラメータ:

t - The Throwable.

戻り値:

An array of strings describing each stack frame.

導入されたバージョン:

2.0

trimStackFrames

protected void trimStackFrames(List stacks)

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.

パラメータ:

stacks - The list containing String[] elements

導入されたバージョン:

2.0