アノテーション検出 (detectAnnotation)

<detectAnnotation> エレメント

detectAnnotation 規則は、Java クラスで使用されているアノテーションを検出します。

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

フラグを立てるアノテーションの完全修飾クラス名。 複数のクラス名を指定する場合は、コンマ区切りリストを使用します。 クラス名のいずれかと一致するアノテーションはフラグが立てられます。
attributeName ストリング いいえ

フラグを立てるアノテーション属性の名前。 指定がない場合、デフォルトは "value"。 "value "は無名属性と等価である。
タイプ ストリング いいえ

属性の型の完全修飾クラス名。 アノテーションの属性は任意のクラスにすることができます。 一般的なタイプには、java.lang.String や java.lang.Boolean があります。
accessFlag 列挙 いいえ

指定した場合、このアクセス・フラグの基準に一致しているクラスまたはインターフェースにあるアノテーションのみにフラグを立てます。 サポートされる値は、以下のとおりです。

  • public
  • non-public
defaultValue ストリング いいえ

値が指定されていない場合にフラグを立てるデフォルト値 (存在する場合)。
missingAttribute ストリング いいえ

この属性が指定されていない場合にのみ、name に指定されているアノテーションにフラグを立てます。
flagOnce ブール値 いいえ

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

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

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

子エレメント (0 個以上)

<field> エレメント- オプション。複数指定可能

表 2. < field> エレメント属性
属性名 タイプ 必須 説明
値 String/正規表現 はい

フラグを立てる属性値。 この値は、attributeName に一致する属性に指定されている場合にフラグが立てられます。

<location> エレメント - オプション。最大で 1 個指定できます

表 3. < location> エレメント属性
属性名 タイプ 必須 説明
タイプ 列挙 はい

指定位置のアノテーションにフラグを立てます。 サポートされる値は、以下のとおりです。

  • クラス
  • インターフェース
  • メソッド (method)
  • field
クラス 正規表現 いいえ

type 属性で指定した位置タイプで突き合わせるクラス名。
defaultName 正規表現 いいえ

指定された正規表現に一致する完全修飾クラス名を持つクラス内にあるアノテーションにフラグを立てます。

例えば、値 test が指定された lookup 属性の javax.ejb.EJB アノテーションを検出するには、以下を指定します。


<detectAnnotation name="javax.ejb.EJB" type="java.lang.String" attributeName="lookup">
    <field value="test"/>
</detectAnnotation>