javax.annotation.processing

Класс AbstractProcessor

java.lang. Объект

javax.annotation.processing.AbstractProcessor

Все Реализованные Интерфейсы:

Процессор

public abstract class AbstractProcessor
extends Object
implements Processor

Абстрактный процессор аннотации, разработанный, чтобы быть удобным суперклассом для большинства конкретных процессоров аннотации. Этот класс исследует значения аннотации, чтобы вычислить опции, аннотации, и исходную версию, поддерживаемую ее подтипами.

Методы метода get могут выпустить предупреждения о примечательных условиях, используя средства, доступные после того, как процессор был инициализирован.

Подклассы свободны переопределить реализацию и спецификацию любого из методов в этом классе пока генерал 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 унаследованный от класса. Объект

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 параметр. IllegalStateException будет брошен, если этот метод вызовут не раз на том же самом объекте.

Определенный:

init в интерфейсе Processor

Параметры:

processingEnv - среда, чтобы получить доступ к средствам платформа инструмента обеспечивает для процессора

Броски:

IllegalStateException - если этот метод вызывают не раз.

процесс

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

Ряд процессов аннотации вводит на элементах типа, происходящих из предшествующего раунда и возвратов, требуются ли эти аннотации этим процессором. Если true возвращается, аннотации требуются, и последующие процессоры не попросят обработать их; если false возвращается, аннотации невостребованны, и последующие процессоры можно попросить обработать их. Процессор может всегда возвращать то же самое булево значение или может изменить результат, основанный на выбранных критериях.

Входной набор будет пуст, если процессор будет поддерживать "*" и у корневых элементов нет никаких аннотаций. A 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 иначе.