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

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

public class ExceptionUtils

extends Object

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

Utility routines for manipulating Throwable objects.

導入されたバージョン:

1.0

作成者:

Daniel Rall

翻訳者:

日置 聡

翻訳状況:

初稿(校正者募集中)

翻訳更新日:

2003/08/07

フィールドの概要

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

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

The names of methods commonly used to access a wrapped exception.

CAUSE_METHOD_PARAMS

protected static final Object[] CAUSE_METHOD_PARAMS

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

The empty parameter list passed to methods used to access a wrapped exception.

コンストラクタの詳細

ExceptionUtils

protected ExceptionUtils()

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

Constructs a new ExceptionUtils. Protected to discourage instantiation.

メソッドの詳細

getCause

public static Throwable getCause(Throwable t)

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

Introspects the specified Throwable for a getCause(), getNextException(), getTargetException(), or getException() method which returns a Throwable object (standard as of JDK 1.4, and part of the {@link org.apache.commons.lang.exception.NestableException} API), extracting and returning the cause of the exception. In the absence of any such method, the object is inspected for a detail field assignable to a Throwable. If none of the above is found, returns null.

パラメータ:

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

The exception to introspect for a cause.

戻り値:

原因となる Throwable

The cause of the Throwable.

getCause

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

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

Extends the API of {@link #getCause(Throwable)} by introspecting for only user-specified method names.

関連項目:

getCause(Throwable)

getRootCause

public static Throwable getRootCause(Throwable t)

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

Walks through the exception chain to the last element -- the "root" of the tree -- using {@link #getCause(Throwable)}, and returns that exception.

戻り値:

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

The root cause of the Throwable.

関連項目:

getCause(Throwable)

getCauseUsingWellKnownTypes

private static Throwable getCauseUsingWellKnownTypes(Throwable t)

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

Uses instanceof checks to examine the exception, looking for well known types which could contain chained or wrapped exceptions.

パラメータ:

t - 調査対象となる例外

The exception to examine.

戻り値:

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

The wrapped exception, or null if not found.

getCauseUsingMethodName

private static Throwable getCauseUsingMethodName(Throwable t,
                                                 String methodName)

パラメータ:

t - 調査対象となる例外

The exception to examine.

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

The name of the method to find and invoke.

戻り値:

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

The wrapped exception, or null if not found.

getCauseUsingFieldName

private static Throwable getCauseUsingFieldName(Throwable t,
                                                String fieldName)

パラメータ:

t - 調査対象となる例外

The exception to examine.

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

The name of the attribute to examine.

戻り値:

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

The wrapped exception, or null if not found.

getThrowableCount

public static int getThrowableCount(Throwable t)

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

Returns the number of Throwable objects in the exception chain.

パラメータ:

t - 調査対象となる例外

The exception to inspect.

戻り値:

見つかった例外の数

The throwable count.

getThrowables

public static Throwable[] getThrowables(Throwable t)

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

Returns the list of Throwable objects in the exception chain.

パラメータ:

t - 調査対象となる例外

The exception to inspect.

戻り値:

Throwable オブジェクトの配列。

The list of Throwable objects.

indexOfThrowable

public static int indexOfThrowable(Throwable t,
                                   Class type)

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

Delegates to {@link #indexOfThrowable(Throwable, Class, int)}, starting the search at the beginning of the exception chain.

関連項目:

indexOfThrowable(Throwable, Class, int)

indexOfThrowable

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

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

Returns the (zero based) index, of the first Throwable that matches the specified type in the exception chain of Throwable objects with an index greater than or equal to the specified index, or -1 if the type is not found.

パラメータ:

t - 調査対象となる例外

The exception to inspect.

type - 検索対象となる Class

Class to look for.

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

The (zero based) index of the starting position in the chain to be searched.

戻り値:

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

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

getStackTrace

public static String getStackTrace(Throwable t)

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

A convenient way of extracting the stack trace from an exception.

パラメータ:

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

The Throwable.

戻り値:

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

The stack trace as generated by the exception's printStackTrace(PrintWriter) method.

getStackFrames

public static 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.

getStackFrames

static String[] getStackFrames(String stackTrace)

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

Functionality shared between the getStackFrames(Throwable) methods of this and the {@link org.apache.commons.lang.exception.NestableDelegate} classes.