クラスAbstractProcessor

java.lang.Object
javax.annotation.processing.AbstractProcessor
すべての実装されたインタフェース:
Processor
public abstract class AbstractProcessor extends Object implements Processor
大部分の具象注釈プロセッサの簡易スーパー・クラスとして設計された、抽象注釈プロセッサ。 このクラスは、注釈値を調べて、サブタイプでサポートされているoptions、「注釈インタフェース」および「ソース・バージョン」をコンピュートします。

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

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

導入されたバージョン:
1.6

  • フィールドのサマリー

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

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

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

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    Iterable<? extends Completion>
    getCompletions(Element element, AnnotationMirror annotation, ExecutableElement member, String userText)
    コンプリートの空の反復可能オブジェクトを返します。
    Set<String>
    getSupportedAnnotationTypes()
    このプロセッサがサポートする注釈インタフェースの名前を返します。
    Set<String>
    getSupportedOptions()
    このプロセッサが認識するオプションを返します。
    SourceVersion
    getSupportedSourceVersion()
    この注釈プロセッサがサポートする最新ソース・バージョンを返します。
    void
    init(ProcessingEnvironment processingEnv)
    指定された処理環境を使用してプロセッサを初期化します。
    protected boolean
    isInitialized()
    このオブジェクトが初期化済みである場合はtrue、それ以外の場合はfalseを返します。
    abstract boolean
    process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
    「ルート要素」の注釈インタフェースのセットを前回のラウンドから開始して処理し、これらの注釈インタフェースがこのプロセッサによって要求されるかどうかを返します。

    クラスオブジェクトで宣言されたメソッド

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    修飾子と型
    メソッド
    説明
    protected Object
    clone()
    このオブジェクトのコピーを作成して、返します。
    boolean
    equals(Object obj)
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。
    protected void
    finalize()
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    最終決定は非推奨であり、将来のリリースで削除される可能性があります。
    final Class<?>
    getClass()
    このObjectの実行時クラスを返します。
    int
    hashCode()
    このオブジェクトに対するハッシュ・コード値を返します。
    final void
    notify()
    このオブジェクトのモニターで待機中のスレッドを1つ再開します。
    final void
    notifyAll()
    このオブジェクトのモニターで待機中のすべてのスレッドを再開します。
    String
    toString()
    オブジェクトの文字列表現を返します。
    final void
    wait()
    現在のスレッドが目覚めるまで待機します。通常、notifiedまたはinterruptedです。
    final void
    wait(long timeoutMillis)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。
    final void
    wait(long timeoutMillis, int nanos)
    現在のスレッドは、通常、notifiedまたはinterruptedであるか、一定のリアルタイムが経過するまで、目覚めるまで待機します。

  • フィールド詳細

    • processingEnv

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

  • コンストラクタの詳細

    • AbstractProcessor

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

  • メソッドの詳細

    • getSupportedOptions

      public Set<String> getSupportedOptions()
      このプロセッサが認識するオプションを返します。
      定義:
      getSupportedOptions、インタフェースProcessor
      実装要件:
      プロセッサ・クラスにSupportedOptionsの注釈が付いている場合、その注釈と同じ一連の文字列を含む変更不可能なセットを返します。 クラスにそのような注釈が付けられていない場合は、空のセットが返されます。
      戻り値:
      このプロセッサが認識するオプション。存在しない場合は空のセット
      関連項目:

    • getSupportedAnnotationTypes

      public Set<String> 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は空の注釈セットを適切に処理しなければいけません。

      定義:
      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