org.apache.commons.lang.exception
インタフェース Nestable

既知の実装クラスの一覧:

NestableError, NestableException, NestableRuntimeException

public interface Nestable

Throwable の実装にルートとなる例外を 内部にネストして持つことができるように拡張を行うインターフェイスです。

バージョン:

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

作成者:

Daniel Rall, Kasper Nielsen, Steven Caswell

翻訳者:

日置 聡

メソッドの概要

Throwable	getCause() Nestable が実装された例外の原因となった例外またはエラーの参照を返します。
String	getMessage() この例外とネストされた Throwable のエラーメッセージを返します。
String	getMessage(int index) 内部に保持されている Throwable のうち、0 から始まる指定されたインデックスに該当する Throwable のメッセージを返します。
String[]	getMessages() この例外と内部にネストされる Throwable のエラーメッセージをStringの配列に格納して返します。
Throwable	getThrowable(int index) 内部に保持されている Throwable のうち、0 から始まる指定されたインデックスに該当する Throwable を返します。
int	getThrowableCount() この Nestable に含まれるネストされた Throwable の数を返します。
Throwable[]	getThrowables() この Nestable と、内部にネストされた Throwable を Throwable の配列に格納して返します。
int	indexOfThrowable(Class type) 内部にネストされた Throwable の中から、最初に見つかった指定された型の 0 から始まるインデックスを返します。
int	indexOfThrowable(Class type, int fromIndex) 内部にネストされた Throwable から、最初に見つかった指定された型の、検索開始位置より後ろの 0 から始まるインデックスを返します。
void	printPartialStackTrace(PrintWriter out) 指定された writer に対してルートとなる(ネストされたものを含まない)例外のスタックトレースを出力します。
void	printStackTrace(PrintStream out) 指定された print stream に対してこの例外のスタックトレースを出力します。
void	printStackTrace(PrintWriter out) 指定された print writer に対してこの例外のスタックトレースを出力します。

メソッドの詳細

getCause

public Throwable getCause()

Nestable が実装された例外の原因となった例外またはエラーの参照を返します。

getMessage

public String getMessage()

この例外とネストされた Throwable のエラーメッセージを返します。

戻り値:

エラーメッセージ

getMessage

public String getMessage(int index)

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

パラメータ:

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

戻り値:

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

例外:

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

getMessages

public String[] getMessages()

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

戻り値:

エラーメッセージ

getThrowable

public Throwable getThrowable(int index)

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

パラメータ:

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

戻り値:

該当する Throwable

例外:

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

getThrowableCount

public int getThrowableCount()

この Nestable に含まれるネストされた Throwable の数を返します。

戻り値:

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

getThrowables

public Throwable[] getThrowables()

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

戻り値:

Throwable の配列

indexOfThrowable

public int indexOfThrowable(Class type)

内部にネストされた Throwable の中から、最初に見つかった指定された型の 0 から始まるインデックスを返します。 該当するものが見つからなかった場合には -1 を返します。

パラメータ:

type - 検索対象となる Class

戻り値:

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

indexOfThrowable

public int indexOfThrowable(Class type,
                            int fromIndex)

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

パラメータ:

type - 検索対象となる Class

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

戻り値:

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

例外:

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

printStackTrace

public void printStackTrace(PrintWriter out)

指定された print writer に対してこの例外のスタックトレースを出力します。 この例外の原因(となる例外)がある場合にはその情報も出力されます。

パラメータ:

out - 出力に使用される PrintWriter

printStackTrace

public void printStackTrace(PrintStream out)

指定された print stream に対してこの例外のスタックトレースを出力します。 この例外の原因(となる例外)がある場合にはその情報も出力されます。

パラメータ:

out - 出力に使用される PrintStream

printPartialStackTrace

public void printPartialStackTrace(PrintWriter out)

指定された writer に対してルートとなる(ネストされたものを含まない)例外のスタックトレースを出力します。 NestableDelegate から、個々のスタックトレースをバッファに出力するために使用されます。 このメソッドの実装は大体の場合 super.printStackTrace(out); を呼ぶべきです。

パラメータ:

out - 使用される writer