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

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

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

Serializable

public class NestableDelegate

extends Object

implements Serializable

バージョン:

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

作成者:

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

関連項目:

直列化された形式

翻訳者:

日置 聡

翻訳状況:

初稿(校正者募集中)

翻訳更新日:

2003/08/06

フィールドの概要

private static String	MUST_BE_THROWABLE コンストラクタのエラーメッセージ。
private Throwable	nestable ラップしている例外またはエラーへの参照(これは Nestable の実装である必要があります)。

コンストラクタの概要

(パッケージプライベート)

NestableDelegate(Nestable nestable) 指定された Nestable を管理する NestableDelegate のインスタンスを新たに生成します。

メソッドの概要

(パッケージプライベート) String	getMessage(int index) 内部に保持されている Throwable のうち、0 から始まる指定されたインデックスに該当する Throwable のメッセージを返します。
(パッケージプライベート) String	getMessage(String baseMsg) Nestable とネストされた Throwable に含まれる全てのメッセージを返します。
(パッケージプライベート) String[]	getMessages() この例外と内部にネストされる Throwable のエラーメッセージをStringの配列に格納して返します。
private String[]	getStackFrames(Throwable t) 指定された Throwable オブジェクトに関連するスタックトレースを捕まえて スタックフレームのリストに再構成します。
(パッケージプライベート) Throwable	getThrowable(int index) 内部に保持されている Throwable のうち、0 から始まる指定されたインデックスに該当する Throwable を返します。
(パッケージプライベート) int	getThrowableCount() このクラスに含まれる Nestable の中の Throwable の数を返します。
(パッケージプライベート) Throwable[]	getThrowables() このクラス内の Nestable と、内部にネストされた Throwable を Throwable の配列に格納して返します。
(パッケージプライベート) int	indexOfThrowable(Class type, int fromIndex) このクラスの Nestable の内部にネストされた Throwable から、最初に見つかった指定された型の、検索開始位置より後ろの 0 から始まるインデックスを返します。
void	printStackTrace() 標準エラー出力にこの例外のスタックトレースを出力します。
void	printStackTrace(PrintStream out) 指定された stream にこの例外のスタックトレースを出力します。
void	printStackTrace(PrintWriter out) 指定された writer にこの例外のスタックトレースを出力します。

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

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

フィールドの詳細

MUST_BE_THROWABLE

private static final transient String MUST_BE_THROWABLE

コンストラクタのエラーメッセージ。

Constructor error message.

関連項目:

定数フィールド値

nestable

private Throwable nestable

ラップしている例外またはエラーへの参照(これは Nestable の実装である必要があります)。

Holds the reference to the exception or error that we're wrapping (which must be a {@link org.apache.commons.lang.exception.Nestable} implementation).

コンストラクタの詳細

NestableDelegate

NestableDelegate(Nestable nestable)

指定された Nestable を管理する NestableDelegate のインスタンスを新たに生成します。

Constructs a new NestableDelegate instance to manage the specified Nestable.

パラメータ:

nestable - the Nestable implementation (must extend Throwable)

メソッドの詳細

getMessage

String getMessage(int index)

内部に保持されている Throwable のうち、0 から始まる指定されたインデックスに該当する Throwable のメッセージを返します。

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

パラメータ:

index - 内部に保持されている Throwable のインデックス

the index of the Throwable in the chain of Throwables

戻り値:

エラーメッセージ、インデックスで指定された Throwable にメッセージが設定されていない場合には null

the error message, or null if the Throwable at the specified index in the chain does not contain a message

例外:

IndexOutOfBoundsException - index の値がマイナスまたは内部の Throwable の数が指定された値よりも少ない場合

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

getMessage

String getMessage(String baseMsg)

Nestable とネストされた Throwable に含まれる全てのメッセージを返します。

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

パラメータ:

baseMsg - 全てのメッセージを作成する際に使用されるベースメッセージ。 一般的に nestableHelper.getMessage(super.getMessage()) を経由して呼ばれます。 super は Throwable のインスタンスを意味します。

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 {@link java.lang.Throwable}.

戻り値:

この例外とネスとされた全ての Throwable のメッセージを連結したメッセージ

The concatenated message for this and all nested Throwables

getMessages

String[] getMessages()

この例外と内部にネストされる Throwable のエラーメッセージをStringの配列に格納して返します。 メッセージを持たない Throwable のメッセージは null で表現されます。 返される配列の長さは原因の数を示す getThrowableCount() の返す値と一致します。

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 {@link #getThrowableCount()} operation.

戻り値:

エラーメッセージ

the error messages

getThrowable

Throwable getThrowable(int index)

内部に保持されている Throwable のうち、0 から始まる指定されたインデックスに該当する Throwable を返します。

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

パラメータ:

index - 内部に保持される Throwable の 0 から始まるインデックス

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

戻り値:

該当する Throwable

the Throwable

例外:

IndexOutOfBoundsException - index の値がマイナスまたは内部の Throwable の数が指定された値よりも少ない場合

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

getThrowableCount

int getThrowableCount()

このクラスに含まれる Nestable の中の Throwable の数を返します。

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

戻り値:

スロー可能オブジェクト(throwable)の数

the throwable count

getThrowables

Throwable[] getThrowables()

このクラス内の Nestable と、内部にネストされた Throwable を Throwable の配列に格納して返します。

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

戻り値:

Throwable の配列

the Throwables

indexOfThrowable

int indexOfThrowable(Class type,
                     int fromIndex)

このクラスの Nestable の内部にネストされた Throwable から、最初に見つかった指定された型の、検索開始位置より後ろの 0 から始まるインデックスを返します。 該当するものが見つからなかった場合には -1 を返します。

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

type Class to be found

fromIndex - 検索の開始位置となる 0 から始まるインデックス

the index, numbered from 0, of the starting position in the chain to be searched

戻り値:

指定された型が最初に見つかったインデックス、見つからなかった場合には -1

index of the first occurrence of the type in the chain, or -1 if the type is not found

例外:

IndexOutOfBoundsException - fromIndexの値がマイナスまたは内部の Throwable の数が指定された値よりも少ない場合

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

printStackTrace

public void printStackTrace()

標準エラー出力にこの例外のスタックトレースを出力します。

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

printStackTrace

public void printStackTrace(PrintStream out)

指定された stream にこの例外のスタックトレースを出力します。

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

パラメータ:

out - 出力に使用される PrintStream

PrintStream to use for output.

関連項目:

printStackTrace(PrintWriter)

printStackTrace

public void printStackTrace(PrintWriter out)

指定された writer にこの例外のスタックトレースを出力します。

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

パラメータ:

out - 出力に使用される PrintWriter

PrintWriter to use for output.

getStackFrames

private String[] getStackFrames(Throwable t)

指定された Throwable オブジェクトに関連するスタックトレースを捕まえて スタックフレームのリストに再構成します。

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

パラメータ:

t - 対象となる Throwable

The Throwable.

戻り値:

スタックフレームの内容を表す文字列の配列

An array of strings describing each stack frame.