Declaration (Mirror API)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Mirror API

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.sun.mirror.declaration
インタフェース Declaration

既知のサブインタフェースの一覧:: AnnotationTypeDeclaration, AnnotationTypeElementDeclaration, ClassDeclaration, ConstructorDeclaration, EnumConstantDeclaration, EnumDeclaration, ExecutableDeclaration, FieldDeclaration, InterfaceDeclaration, MemberDeclaration, MethodDeclaration, PackageDeclaration, ParameterDeclaration, TypeDeclaration, TypeParameterDeclaration

public interface Declaration

パッケージ、クラス、またはメソッドといったプログラム要素の宣言を表します。各宣言は、仮想マシンの実行時の構成要素などではなく、静的な言語レベルの構成要素を表し、一般にソースコードの特定のフラグメントと一対一で対応します。

宣言は、equals(Object) メソッドを使って比較する必要があります。特定の宣言が常に同じオブジェクトにより表されるとはかぎりません。

導入されたバージョン:: 1.5
関連項目:: Declarations, TypeMirror

メソッドの概要

void accept(DeclarationVisitor v)
この宣言にビジタを適用します。

boolean equals(Object obj)
オブジェクトがこの宣言と同じ宣言を表すかどうかをテストします。





<A extends Annotation> 


A

getAnnotation(Class<A> annotationType)
指定した型を持つこの宣言の注釈を返します。

Collection<AnnotationMirror> getAnnotationMirrors()
この宣言で直接表された注釈を返します。

String getDocComment()
この宣言のドキュメンテーション (javadoc) コメントのテキストを返します。

Collection<Modifier> getModifiers()
注釈を除く、この宣言の修飾子を返します。

SourcePosition getPosition()
この宣言の先頭のソース位置を返します。

String getSimpleName()
この宣言の単純 (非修飾) 名を返します。

メソッドの詳細

equals

boolean equals(Object obj)

オブジェクトがこの宣言と同じ宣言を表すかどうかをテストします。

オーバーライド:: クラス Object 内の equals

パラメータ:: obj - この宣言と比較されるオブジェクト
戻り値:: 指定されたオブジェクトがこの宣言と同じ宣言を表す場合は true

getDocComment

String getDocComment()

この宣言のドキュメンテーション (javadoc) コメントのテキストを返します。

戻り値:: この宣言のドキュメンテーションコメント、ない場合は null

getAnnotationMirrors

Collection<AnnotationMirror> getAnnotationMirrors()

この宣言で直接表された注釈を返します。

戻り値:: この宣言で直接表された注釈、ない場合は空のコレクション

getAnnotation

<A extends Annotation> A getAnnotation(Class<A> annotationType)

指定した型を持つこの宣言の注釈を返します。注釈は継承されるか、あるいはこの宣言で直接表されるかのどちらかです。

このメソッドが返す注釈には、Class 型の値を持つ要素が含まれる場合があります。この値は直接返されません。つまり、クラスローダーを使用するための情報など、クラスを見つけてロードするのに必要な情報は利用できません。返される注釈で関連するメソッドを呼び出すことにより Class オブジェクトを読み込もうとすると、MirroredTypeException が発生します。これから、対応する TypeMirror を抽出することができます。同様に、Class[] の値による要素を読み込もうとすると、MirroredTypesException が発生します。

注:このメソッドは、このインタフェースおよび関連するインタフェースのほかのメソッドとは異なります。このメソッドは、これらのインタフェースにより定義され、これらのインタフェースを通じて使用されるミラー化表現に対して操作を行うのではなく、実行時リフレクト情報 (仮想マシンに現在ロードされている注釈型の表現) に対して操作を行います。このメソッドは、注釈型の既知の固定セットに対して操作を行うように記述された呼び出し側を対象としています。

型パラメータ:: A - 注釈型
パラメータ:: annotationType - 注釈型に対応する Class オブジェクト
戻り値:: 指定された型を持つこの宣言の釈型
関連項目:: getAnnotationMirrors()

getModifiers

Collection<Modifier> getModifiers()

注釈を除く、この宣言の修飾子を返します。インタフェースのメンバーの public 修飾子と static 修飾子などの暗黙的な修飾子を含みます。

戻り値:: この宣言の修飾子 (順序は定義されていない)、ない場合は空のコレクション

getSimpleName

String getSimpleName()

この宣言の単純 (非修飾) 名を返します。総称型の名前には、仮型パラメータへの参照は含まれません。たとえば、インタフェース宣言 java.util.Set<E> の単純名は「Set」です。この宣言が空のパッケージを表す場合、空の文字列が返されます。この宣言がコンストラクタを表す場合、宣言しているクラスの単純名が返されます。