java.lang.Object
javax.annotation.processing.AbstractProcessor
- すべての実装されたインタフェース:
Processor
大部分の具象注釈プロセッサの簡易スーパー・クラスとして設計された、抽象注釈プロセッサ。 このクラスは、注釈値を調べて、サブタイプでサポートされているoptions、「注釈インタフェース」および「ソース・バージョン」をコンピュートします。
getterメソッドは、プロセッサの初期化後に使用可能となる機能を使って、通知する価値のある状態に関する警告を発行する可能性があります。
サブクラスは、このクラス内の任意のメソッドの実装や仕様を自由にオーバーライドできます。ただしその際、そのメソッドに対するProcessorの一般規約には従う必要があります。
- 導入されたバージョン:
- 1.6
-
フィールドのサマリー
フィールド -
コンストラクタのサマリー
コンストラクタ -
メソッドのサマリー
修飾子と型メソッド説明Iterable<? extends Completion> getCompletions(Element element, AnnotationMirror annotation, ExecutableElement member, String userText) コンプリートの空の反復可能オブジェクトを返します。このプロセッサがサポートする注釈インタフェースの名前を返します。このプロセッサが認識するオプションを返します。この注釈プロセッサがサポートする最新ソース・バージョンを返します。voidinit(ProcessingEnvironment processingEnv) 指定された処理環境を使用してプロセッサを初期化します。protected booleanこのオブジェクトが初期化済みである場合はtrue、それ以外の場合はfalseを返します。abstract booleanprocess(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) 「ルート要素」の注釈インタフェースのセットを前回のラウンドから開始して処理し、これらの注釈インタフェースがこのプロセッサによって要求されるかどうかを返します。
-
フィールド詳細
-
processingEnv
protected ProcessingEnvironment processingEnvツール・フレームワークによって提供された処理環境。
-
-
コンストラクタの詳細
-
AbstractProcessor
protected AbstractProcessor()サブクラスが呼び出すためのコンストラクタ。
-
-
メソッドの詳細
-
getSupportedOptions
このプロセッサが認識するオプションを返します。- 定義:
getSupportedOptions、インタフェースProcessor- 実装要件:
- プロセッサ・クラスに
SupportedOptionsの注釈が付いている場合、その注釈と同じ一連の文字列を含む変更不可能なセットを返します。 クラスにそのような注釈が付けられていない場合は、空のセットが返されます。 - 戻り値:
- このプロセッサが認識するオプション。存在しない場合は空のセット
- 関連項目:
-
getSupportedAnnotationTypes
このプロセッサがサポートする注釈インタフェースの名前を返します。- 定義:
getSupportedAnnotationTypes、インタフェースProcessor- 実装要件:
- プロセッサ・クラスに
SupportedAnnotationTypesの注釈が付いている場合、その注釈と同じ一連の文字列を含む変更不可能なセットを返します。 クラスにそのような注釈が付けられていない場合は、空のセットが返されます。 「ソース・バージョン」がモジュールをサポートしない場合、つまりそれがRELEASE_8以下の場合、先行する「モジュール・プレフィクス」は名前から削除されます。 - 戻り値:
- このプロセッサがサポートする注釈インタフェースの名前。存在しない場合は空のセット
- 関連項目:
-
getSupportedSourceVersion
public SourceVersion getSupportedSourceVersion()この注釈プロセッサがサポートする最新ソース・バージョンを返します。- 定義:
getSupportedSourceVersion、インタフェースProcessor- 実装要件:
- プロセッサ・クラスに
SupportedSourceVersionの注釈が付けられている場合、その注釈内のソース・バージョンを返します。 クラスにそのような注釈が付けられていない場合は、SourceVersion.RELEASE_6が返されます。 - 戻り値:
- この注釈プロセッサがサポートする最新ソース・バージョン
- 関連項目:
-
init
public void init(ProcessingEnvironment processingEnv) 指定された処理環境を使用してプロセッサを初期化します。- 定義:
init、インタフェースProcessor- 実装要件:
- 処理環境を使ってプロセッサを初期化するために、
processingEnvフィールドをprocessingEnv引数の値に設定します。 このメソッドが同じオブジェクト上で2回以上呼び出されると、IllegalStateExceptionがスローされます。 - パラメータ:
processingEnv- ツール・フレームワークがプロセッサに対して提供する機能にアクセスするための環境- 例外:
IllegalStateException- このメソッドが2回以上呼び出された場合。
-
process
public abstract boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) 「ルート要素」の注釈インタフェースのセットを前回のラウンドから開始して処理し、これらの注釈インタフェースがこのプロセッサによって要求されるかどうかを返します。trueが返された場合、注釈インタフェースは要求され、後続のプロセッサはそれらを処理するように要求されません。falseが返された場合、注釈インタフェースは要求されず、後続のプロセッサはそれらを処理するように要求されることがあります。 プロセッサは、常に同じブール値を返すことも、独自に選択した基準に基づいて結果を変えることもできます。プロセッサが
"*"をサポートしていてルート要素が注釈を1つも持たない場合、入力のセットは空になります。Processorは空の注釈セットを適切に処理しなければいけません。 -
getCompletions
public Iterable<? extends Completion> getCompletions(Element element, AnnotationMirror annotation, ExecutableElement member, String userText) コンプリートの空の反復可能オブジェクトを返します。- 定義:
getCompletions、インタフェースProcessor- パラメータ:
element- 注釈が付けられる要素annotation- 要素に適用される(おそらく部分的な)注釈member- 可能なコンプリートを返す対象となる注釈メンバーuserText- コンプリートの対象となるソース・コード・テキスト- 戻り値:
- 完了の空の反復可能オブジェクト
-
isInitialized
-