メソッド検出 (detectMethod)

<detectMethod> エレメント

detectMethod 規則は、Java クラス・ファイル内のメソッドを検出するために使用します。

表1. <detectMethod> 要素属性
属性名 タイプ 必須 説明
名前 ストリング はい

メソッド名。 複数指定する場合は、コンマ区切りリストを使用します。

所有者 ストリング はい

メソッドが定義されているクラスの完全修飾クラス名。 複数指定する場合は、コンマ区切りリストを使用します。

returnType ストリング いいえ

戻りの型の完全修飾クラス名。

引数 ストリング いいえ

メソッド引数の完全修飾クラス名またはプリミティブ。 複数指定する場合は、コンマ区切りリストを使用します。 パラメーターのないメソッドにフラグを立てる場合は、空ストリングを指定します。 指定されていない場合、すべてのメソッド・シグニチャーにフラグを立てます。

excludePackageNames ストリング いいえ

完全修飾パッケージ名。 複数指定する場合は、コンマ区切りリストを使用します。 これは、特定のパッケージ内のクラスでのメソッドのフラグ立てを除外するために使用できます。 すべてのサブパッケージに一致させる場合は、.* をパッケージに追加します。 パッケージとすべてのサブパッケージに一致させる場合は、パッケージ名に * のみを追加します。

flagCatchExceptions ストリング いいえ

例外の完全修飾クラス名。 複数指定する場合は、コンマ区切りリストを使用します。 指定した例外のいずれかでメソッドの呼び出しが try-catch ブロック内にある場合、その呼び出しにフラグを立てます。

flagUnhandledExceptions ストリング いいえ

例外の完全修飾クラス名。 複数指定する場合は、コンマ区切りリストを使用します。 指定した例外がいずれも呼び出し側メソッドによって catch/throw されていない場合、メソッドの呼び出しにフラグを立てます。

flagOnce ブール値 いいえ

アーカイブごとに 1 回フラグを立てるかどうかを指定します。 デフォルト値は false です。

flagOncePerFile ブール値 いいえ

ファイルごとに 1 回フラグを立てるかどうかを指定します。 デフォルト値は false です。

hideResult ブール値 いいえ

この規則によってフラグが立てられた結果をレポートで非表示にするかどうかを示します。 この属性は、< and> または < or> タグの下のルールで使用された場合にのみ結果を非表示にします。 デフォルト値は false です。

例えば、任意のメソッド・シグニチャーを持つ、java.util.Properties クラスの load メソッドを検出するには、以下を指定します。


<detectMethod name="load" owners="java.util.Properties"/>