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

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

public class ExceptionUtils

extends Object

Throwable オブジェクトを処理するためのユーティリティルーチンです。

導入されたバージョン:

1.0

作成者:

Daniel Rall

翻訳者:

日置 聡

フィールドの概要

protected static String[]	CAUSE_METHOD_NAMES ラップされている例外にアクセスする際に一般的に使用されるメソッドの名称。
protected static Object[]	CAUSE_METHOD_PARAMS ラップされている例外にアクセスする際に渡される空のパラメータリスト。

コンストラクタの概要

protected

ExceptionUtils() 新規 ExceptionUtils を生成します。

メソッドの概要

static Throwable	getCause(Throwable t) 指定された Throwable の Throwable オブジェクトを返す(標準の JDK 1.4 と NestableException のAPIの) getCause()、 getNextException()、 getTargetException()、 getException() メソッド を利用して原因となる例外を抽出し、返します。
static Throwable	getCause(Throwable t, String[] methodNames) getCause(Throwable) を指定されたメソッドのみを使用するように拡張します。
private static Throwable	getCauseUsingFieldName(Throwable t, String fieldName)
private static Throwable	getCauseUsingMethodName(Throwable t, String methodName)
private static Throwable	getCauseUsingWellKnownTypes(Throwable t) 指定された例外に対して instanceof のチェックを行い 内部にネストされた例外を持ちうる想定された型であった場合、その内部の例外を返します。
static Throwable	getRootCause(Throwable t) getCause(Throwable) を使用して内部の例外をたどり、 根本の原因(root)となる例外を返します。
(パッケージプライベート) static String[]	getStackFrames(String stackTrace) このクラスの getStackFrames(Throwable) メソッドと NestableDelegate クラスにて使用される機能。
static String[]	getStackFrames(Throwable t) 指定された Throwable に関連するスタックトレースを取得し、 スタックフレームの配列に分解します。
static String	getStackTrace(Throwable t) 例外からスタックトレースを抜き出す簡単な方法を提供します。
static int	getThrowableCount(Throwable t) 内部に含まれるネストされた例外をたどって設定されている Throwable オブジェクトの数を返します。
static Throwable[]	getThrowables(Throwable t) 内部に含まれるネストされた例外をたどって設定されている Throwable オブジェクトを配列に格納し返します。
static int	indexOfThrowable(Throwable t, Class type) indexOfThrowable(Throwable, Class, int) に処理を委譲し、 内部の例外の先頭から対象となる例外を検索します。
static int	indexOfThrowable(Throwable t, Class type, int fromIndex) 内部の例外から指定された型に該当する Throwable を検索し、0から始まるインデックスを返します。

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

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

フィールドの詳細

CAUSE_METHOD_NAMES

protected static final String[] CAUSE_METHOD_NAMES

ラップされている例外にアクセスする際に一般的に使用されるメソッドの名称。

CAUSE_METHOD_PARAMS

protected static final Object[] CAUSE_METHOD_PARAMS

ラップされている例外にアクセスする際に渡される空のパラメータリスト。

コンストラクタの詳細

ExceptionUtils

protected ExceptionUtils()

新規 ExceptionUtils を生成します。インスタンス化を制限します。

メソッドの詳細

getCause

public static Throwable getCause(Throwable t)

指定された Throwable の Throwable オブジェクトを返す(標準の JDK 1.4 と NestableException のAPIの) getCause()、 getNextException()、 getTargetException()、 getException() メソッド を利用して原因となる例外を抽出し、返します。 上記のものが見つからない場合 null を返します。

パラメータ:

t - 内部にある原因となる例外

戻り値:

原因となる Throwable

getCause

public static Throwable getCause(Throwable t,
                                 String[] methodNames)

getCause(Throwable) を指定されたメソッドのみを使用するように拡張します。

関連項目:

getCause(Throwable)

getRootCause

public static Throwable getRootCause(Throwable t)

getCause(Throwable) を使用して内部の例外をたどり、 根本の原因(root)となる例外を返します。

戻り値:

根本の原因(root)となる Throwable.

関連項目:

getCause(Throwable)

getCauseUsingWellKnownTypes

private static Throwable getCauseUsingWellKnownTypes(Throwable t)

指定された例外に対して instanceof のチェックを行い 内部にネストされた例外を持ちうる想定された型であった場合、その内部の例外を返します。

パラメータ:

t - 調査対象となる例外

戻り値:

ラップされた例外、該当するものが見つからなかった場合には null

getCauseUsingMethodName

private static Throwable getCauseUsingMethodName(Throwable t,
                                                 String methodName)

パラメータ:

t - 調査対象となる例外

methodName - 検索し、実行するメソッド名

戻り値:

ラップされた例外、該当するものが見つからなかった場合には null

getCauseUsingFieldName

private static Throwable getCauseUsingFieldName(Throwable t,
                                                String fieldName)

パラメータ:

t - 調査対象となる例外

fieldName - 調査対象となる属性(フィールド)名

戻り値:

ラップされた例外、該当するものが見つからなかった場合には null

getThrowableCount

public static int getThrowableCount(Throwable t)

内部に含まれるネストされた例外をたどって設定されている Throwable オブジェクトの数を返します。

パラメータ:

t - 調査対象となる例外

戻り値:

見つかった例外の数

getThrowables

public static Throwable[] getThrowables(Throwable t)

内部に含まれるネストされた例外をたどって設定されている Throwable オブジェクトを配列に格納し返します。

パラメータ:

t - 調査対象となる例外

戻り値:

Throwable オブジェクトの配列。

indexOfThrowable

public static int indexOfThrowable(Throwable t,
                                   Class type)

indexOfThrowable(Throwable, Class, int) に処理を委譲し、 内部の例外の先頭から対象となる例外を検索します。

関連項目:

indexOfThrowable(Throwable, Class, int)

indexOfThrowable

public static int indexOfThrowable(Throwable t,
                                   Class type,
                                   int fromIndex)

内部の例外から指定された型に該当する Throwable を検索し、0から始まるインデックスを返します。 指定されたインデックス位置から検索を実施します。 該当するものが見つからなかった場合には -1 を返します。

パラメータ:

t - 調査対象となる例外

type - 検索対象となる Class

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

戻り値:

指定された型に該当するものが最初に見つかった位置、該当するものが見つからなかった場合には -1

例外:

IndexOutOfBoundsException - fromIndex がマイナスだった場合 または内部に含まれる Throwable の数より大きかった場合

getStackTrace

public static String getStackTrace(Throwable t)

例外からスタックトレースを抜き出す簡単な方法を提供します。

パラメータ:

t - スタックトレースを取得する対象となる Throwable.

戻り値:

例外の printStackTrace(PrintWriter) メソッドにて生成された スタックトレース

getStackFrames

public static String[] getStackFrames(Throwable t)

指定された Throwable に関連するスタックトレースを取得し、 スタックフレームの配列に分解します。

パラメータ:

t - スタックフレームを取得する対象となる Throwable.

戻り値:

分解されたスタックフレームの文字列の配列

getStackFrames

static String[] getStackFrames(String stackTrace)

このクラスの getStackFrames(Throwable) メソッドと NestableDelegate クラスにて使用される機能。