Класс AbstractProcessor

public abstract class AbstractProcessor
extends Object
implements Processor

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

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

Подклассы могут свободно переопределять реализацию и спецификацию любого из методов в этом классе, при условии соблюдения общего Processor контракта для данного метода.

Поля

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 - если этот метод вызывается более одного раза.

process

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

Определено в:

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 в противном случае.