- 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
を返します。
-
-
-
フィールドの詳細
-
processingEnv
protected ProcessingEnvironment processingEnv
ツール・フレームワークによって提供された処理環境。
-
-
メソッドの詳細
-
getSupportedOptions
public Set<String> getSupportedOptions()
プロセッサ・クラスにSupportedOptions
の注釈が付いている場合、その注釈と同じ一連の文字列を含む変更不可能なセットを返します。 クラスにそのような注釈が付けられていない場合は、空のセットが返されます。- 定義:
getSupportedOptions
、インタフェース:Processor
- 戻り値:
- このプロセッサが認識するオプション。存在しない場合は空のセット
- 関連項目:
SupportedOptions
-
getSupportedAnnotationTypes
public Set<String> getSupportedAnnotationTypes()
プロセッサ・クラスにSupportedAnnotationTypes
の注釈が付いている場合、その注釈と同じ一連の文字列を含む変更不可能なセットを返します。 クラスにそのような注釈が付けられていない場合は、空のセットが返されます。source version
がモジュールをサポートしていない場合、つまりRELEASE_8
以下の場合、先頭のmodule prefixes
は名前から削除されます。- 定義:
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回以上呼び出された場合。
-
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
。
-
-