java.lang.reflect

インタフェース AnnotatedElement

既知のすべての実装クラス:

AccessibleObject, Class, Constructor, Field, Method, Package

public interface AnnotatedElement

この VM で現在実行されているプログラムの注釈付き要素を表します。このインタフェースを使用すると、注釈をリフレクト的に呼び出すことができます。このインタフェースのメソッドにより返されたすべての注釈は、不変に保たれ、直列化可能です。呼び出し元は、配列値を持つ列挙メンバーのアクセス用メソッドにより返された配列を変更できます。 この変更は、ほかの呼び出し元に返される配列に影響を及ぼしません。

このインタフェースのメソッドにより返された注釈が、この VM でアクセスできないクラスを参照している Class の値を持つメンバーを (直接または間接に) 含む場合、関連するクラスを返すメソッドを返された注釈で呼び出してクラスを読み取ろうとすると、TypeNotPresentException がスローされます。

同様に、注釈の列挙定数が列挙型にもはや存在しない場合に、列挙値を持つメンバーを読み取ろうとすると、EnumConstantNotPresentException がスローされます。

最後に、互換性なく開発された定義を持つメンバーを読み取ろうとすると、AnnotationTypeMismatchException または IncompleteAnnotationException がスローされます。

導入されたバージョン:

1.5

関連項目:

EnumConstantNotPresentException, TypeNotPresentException, AnnotationFormatError, AnnotationTypeMismatchException, IncompleteAnnotationException

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
<T extends Annotation> T	getAnnotation(Class<T> annotationClass) 存在する場合は、この要素の指定された型の注釈を返し、そうでない場合は null を返します。
Annotation[]	getAnnotations() この要素に存在するすべての注釈を返します。
Annotation[]	getDeclaredAnnotations() この要素に直接存在するすべての注釈を返します。
boolean	isAnnotationPresent(Class<? extends Annotation> annotationClass) 指定された型の注釈がこの要素に存在する場合は true を返し、そうでない場合は false を返します。

メソッドの詳細

isAnnotationPresent

boolean isAnnotationPresent(Class<? extends Annotation> annotationClass)

指定された型の注釈がこの要素に存在する場合は true を返し、そうでない場合は false を返します。このメソッドは、主にマーカー注釈への簡易アクセスを目的に設計されています。

パラメータ:

annotationClass - 注釈型に対応する Class オブジェクト

戻り値:

指定された注釈型の注釈がこの要素に存在する場合は true、そうでない場合は false

例外:

NullPointerException - 指定された注釈クラスが null の場合

導入されたバージョン:

1.5

getAnnotation

<T extends Annotation> T getAnnotation(Class<T> annotationClass)

存在する場合は、この要素の指定された型の注釈を返し、そうでない場合は null を返します。

パラメータ:

annotationClass - 注釈型に対応する Class オブジェクト

戻り値:

存在する場合は、この要素の指定された注釈型の注釈。そうでない場合は null

例外:

NullPointerException - 指定された注釈クラスが null の場合

導入されたバージョン:

1.5

getAnnotations

Annotation[] getAnnotations()

この要素に存在するすべての注釈を返します。(この要素に注釈がない場合は長さゼロの配列を返します。) このメソッドの呼び出し元は、返された配列を自由に変更することができ、これはほかの呼び出し元に返された配列に影響を及ぼしません。

戻り値:

この要素に存在するすべての注釈

導入されたバージョン:

1.5

getDeclaredAnnotations

Annotation[] getDeclaredAnnotations()

この要素に直接存在するすべての注釈を返します。このインタフェースにあるほかのメソッドとは異なり、このメソッドは継承された注釈を無視します。(この要素に注釈が直接存在しない場合は長さゼロの配列を返します。) このメソッドの呼び出し元は、返された配列を自由に変更することができ、これはほかの呼び出し元に返された配列に影響を及ぼしません。

戻り値:

この要素に直接存在するすべての注釈

導入されたバージョン:

1.5