com.sun.mirror.apt
インタフェース AnnotationProcessorFactory

public interface AnnotationProcessorFactory

注釈プロセッサを生成するためのファクトリ。各ファクトリは、1 つ以上の注釈型のプロセッサを生成します。ファクトリは、これらの型を「サポートする」と表現されます。

AnnotationProcessorFactory の各実装では、ツールがファクトリをインスタンス化するために使用する public 引数なしコンストラクタを提供する必要があります。

導入されたバージョン:

1.5

メソッドの概要

AnnotationProcessor	getProcessorFor(Set<AnnotationTypeDeclaration> atds, AnnotationProcessorEnvironment env) 注釈型のセットをサポートする注釈プロセッサを返します。
Collection<String>	supportedAnnotationTypes() このファクトリがサポートする注釈型の名前を返します。
Collection<String>	supportedOptions() このファクトリが認識したオプションまたはファクトリが生成するプロセッサが認識したオプションを返します。

メソッドの詳細

supportedOptions

Collection<String> supportedOptions()

このファクトリが認識したオプションまたはファクトリが生成するプロセッサが認識したオプションを返します。プロセッサ固有のオプションだけが含まれます。これらは「-A」で始まります。たとえば、このファクトリが -Adebug -Aloglevel=3 などのオプションを認識すると、「-Adebug」および「-Aloglevel」文字列を返します。

ツールは、この情報を使って、ユーザーが指定したオプションをプロセッサが認識するかどうかを判定します。 認識しない場合、ツールはエラーを報告します。

戻り値:

このファクトリが認識するオプションまたはファクトリが生成できるプロセッサが認識するオプション、ない場合は空のコレクション

supportedAnnotationTypes

Collection<String> supportedAnnotationTypes()

このファクトリがサポートする注釈型の名前を返します。結果の要素は、サポートされる注釈型の正規の (完全指定) 名である可能性があります。または、「name」で始まる正規の名前を持つすべての注釈型のセットを表す「name.*」の形式である可能性があります。最終的に、「*」自体はすべての注釈型のセットを表します。

戻り値:

戻り値: このファクトリがサポートする注釈型の名前

getProcessorFor

AnnotationProcessor getProcessorFor(Set<AnnotationTypeDeclaration> atds,
                                    AnnotationProcessorEnvironment env)

注釈型のセットをサポートする注釈プロセッサを返します。ファクトリが「*」をサポートしていて、指定された型宣言が注釈を持たない場合、セットは空になります。注釈型のセットは、ファクトリにリスナーを登録する機会を与えるなど、ほかの理由により空になる場合があります。AnnotationProcessorFactory は、注釈の空のセットを正常に処理しなければいけません。 空のセットに対する適切な応答で、AnnotationProcessors.NO_OP が返されることがよくあります。

パラメータ:

atds - 処理される注釈型の型の宣言

env - 処理中に使用される環境

戻り値:

指定された注釈型をサポートする注釈プロセッサ。型がサポートされていない場合、またはプロセッサを作成できない場合は null