javax.annotation.processing

クラス AbstractProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

すべての実装されたインタフェース:

Processor

public abstract class AbstractProcessor
extends Object
implements Processor

大部分の具象注釈プロセッサの簡易スーパークラスとして設計された、抽象注釈プロセッサ。このクラスは、注釈の値を検査することで、そのサブ型がサポートするオプション、注釈、およびソースバージョンを計算します。

getter メソッドは、プロセッサの初期化後に使用可能となる機能を使って、通知する価値のある状態に関する警告を発行する可能性があります。

サブクラスは、このクラス内の任意のメソッドの実装や仕様を自由にオーバーライドできます。ただしその際、そのメソッドに対する Processor の一般規約には従う必要があります。

導入されたバージョン:

1.6

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
protected ProcessingEnvironment	processingEnv ツールフレームワークによって提供された処理環境。

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	AbstractProcessor() サブクラスが呼び出すためのコンストラクタ。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
Iterable<? extends Completion>	getCompletions(Element element, AnnotationMirror annotation, ExecutableElement member, String userText) コンプリートの空の反復可能オブジェクトを返します。
Set<String>	getSupportedAnnotationTypes() プロセッサクラスに SupportedAnnotationTypes の注釈が付いている場合、その注釈と同じ一連の文字列を含む変更不可能なセットを返します。
Set<String>	getSupportedOptions() プロセッサクラスに SupportedOptions の注釈が付いている場合、その注釈と同じ一連の文字列を含む変更不可能なセットを返します。
SourceVersion	getSupportedSourceVersion() プロセッサクラスに SupportedSourceVersion の注釈が付けられている場合、その注釈内のソースバージョンを返します。
void	init(ProcessingEnvironment processingEnv) 処理環境を使ってプロセッサを初期化するために、processingEnv フィールドを processingEnv 引数の値に設定します。
protected boolean	isInitialized() このオブジェクトが初期化済みである場合は true、それ以外の場合は false を返します。
abstract boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) 前回のラウンドで生成された型要素の注釈型のセットを処理し、このプロセッサがそれらの注釈を要求するかどうかを返します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

processingEnv

protected ProcessingEnvironment processingEnv

ツールフレームワークによって提供された処理環境。

コンストラクタの詳細

AbstractProcessor

protected AbstractProcessor()

サブクラスが呼び出すためのコンストラクタ。

メソッドの詳細

getSupportedOptions

public Set<String> getSupportedOptions()

プロセッサクラスに SupportedOptions の注釈が付いている場合、その注釈と同じ一連の文字列を含む変更不可能なセットを返します。クラスにそのような注釈が付けられていない場合は、空のセットが返されます。

定義:

getSupportedOptions、インタフェース: Processor

戻り値:

このプロセッサが認識するオプション。存在しない場合は空のセット

関連項目:

SupportedOptions

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

プロセッサクラスに SupportedAnnotationTypes の注釈が付いている場合、その注釈と同じ一連の文字列を含む変更不可能なセットを返します。クラスにそのような注釈が付けられていない場合は、空のセットが返されます。

定義:

getSupportedAnnotationTypes、インタフェース: Processor

戻り値:

このプロセッサがサポートする注釈型の名前。存在しない場合は空のセット

関連項目:

SupportedAnnotationTypes

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

プロセッサクラスに SupportedSourceVersion の注釈が付けられている場合、その注釈内のソースバージョンを返します。クラスにそのような注釈が付けられていない場合は、SourceVersion.RELEASE_6 が返されます。

定義:

getSupportedSourceVersion、インタフェース: Processor

戻り値:

このプロセッサがサポートする最新ソースバージョン

関連項目:

SupportedSourceVersion, ProcessingEnvironment.getSourceVersion()

init

public void init(ProcessingEnvironment processingEnv)

処理環境を使ってプロセッサを初期化するために、processingEnv フィールドを processingEnv 引数の値に設定します。このメソッドが同じオブジェクト上で 2 回以上呼び出されると、IllegalStateException がスローされます。

定義:

init、インタフェース: Processor

パラメータ:

processingEnv - ツールフレームワークがプロセッサに対して提供する機能にアクセスするための環境

例外:

IllegalStateException - このメソッドが 2 回以上呼び出された場合。

process

public abstract boolean process(Set<? extends TypeElement> annotations,
              RoundEnvironment roundEnv)

前回のラウンドで生成された型要素の注釈型のセットを処理し、このプロセッサがそれらの注釈を要求するかどうかを返します。true が返された場合、それらの注釈は要求され、後続のプロセッサがそれらの処理を依頼されることはありません。false が返された場合、それらの注釈は要求されず、後続のプロセッサはおそらくそれらの処理を依頼されます。プロセッサは、常に同じ boolean 値を返すことも、選択された条件に基づいて結果を変えることもできます。

プロセッサが "*" をサポートしていてルート要素が注釈を 1 つも持たない場合、入力のセットは空になります。Processor は空の注釈セットを適切に処理しなければいけません。

定義:

process、インタフェース: Processor

パラメータ:

annotations - 処理を要求された注釈型

roundEnv - 現在および前回のラウンドについての情報に対する環境

戻り値:

このプロセッサが注釈のセットを要求するかどうか

getCompletions

public Iterable<? extends Completion> getCompletions(Element element,
                                            AnnotationMirror annotation,
                                            ExecutableElement member,
                                            String userText)

コンプリートの空の反復可能オブジェクトを返します。

定義:

getCompletions、インタフェース: Processor

パラメータ:

element - 注釈が付けられる要素

annotation - 要素に適用される (おそらく部分的な) 注釈

member - 可能なコンプリートを返す対象となる注釈メンバー

userText - コンプリートの対象となるソースコードテキスト

戻り値:

注釈に対する推奨のコンプリート

isInitialized

protected boolean isInitialized()

このオブジェクトが初期化済みである場合は true、それ以外の場合は false を返します。

戻り値:

このオブジェクトが初期化済みである場合は true、それ以外の場合は false。