Класс AbstractProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

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

public abstract class AbstractProcessor extends Object implements Processor

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

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

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

С момента:: 1.6

Краткое описание полей

Модификатор и тип	Поле	Описание
`protected ProcessingEnvironment`	`processingEnv`	Обрабатывающая среда, предоставляемая фреймворком инструмента.

Краткое описание конструкторов

AbstractProcessor()

Модификатор	Конструктор	Описание
`protected`	Конструктор для вызова подклассами.

Краткое описание методов

Модификатор и тип	Метод	Описание
`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`. Будет выброшено исключение `processingEnv`, если этот метод вызывается более одного раза для одного и того же объекта.
`protected boolean`	`isInitialized()`	Возвращает `true`, если этот объект был инициализирован, `false` в противном случае.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Методы, объявленные в интерфейсе javax.annotation.processing.Processor

process

Подробное описание полей

processingEnv

protected ProcessingEnvironment processingEnv

Обрабатывающая среда, предоставляемая фреймворком инструмента.

Подробное описание конструкторов

AbstractProcessor

protected AbstractProcessor()

Конструктор для вызова подклассами.

Подробное описание методов

getSupportedOptions

public Set<String> getSupportedOptions()

Если класс процессора аннотирован SupportedOptions, возвращает неизменяемый набор с тем же набором строк, что и аннотация. Если класс не аннотирован, возвращается пустой набор.

Указано в:

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

Возвращает:

опции, распознаваемые этим процессором, или пустой набор, если таковых нет

См. также:

SupportedOptions

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

Если класс процессора аннотирован SupportedAnnotationTypes, возвращает неизменяемый набор с тем же набором строк, что и аннотация. Если класс не аннотирован, возвращается пустой набор. Если версия исходного кода не поддерживает модули, то есть она меньше или равна RELEASE_8, все префиксы модуля из имён удаляются.

Указано в:

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

Возвращает:

названия интерфейсов аннотаций, поддерживаемых этим процессором, или пустой набор, если таковых нет

См. также:

SupportedAnnotationTypes

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Если класс процессора аннотирован SupportedSourceVersion, возвращает версию исходного кода в аннотации. Если класс не аннотирован, возвращается SourceVersion.RELEASE_6.

Указано в:

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

Возвращает:

самую последнюю версию исходного кода, поддерживаемую этим процессором

См. также:

init

public void init(ProcessingEnvironment processingEnv)

Инициализирует процессор с обрабатывающей средой, установив поле processingEnv в значение аргумента processingEnv. Будет выброшено исключение


 IllegalStateException

, если этот метод вызывается более одного раза для одного и того же объекта.

Указано в:: init в интерфейсе Processor
Параметры:: processingEnv - среда для доступа к возможностям, предоставляемым фреймворком инструмента процессору
Исключения:: IllegalStateException - если этот метод вызывается более одного раза.

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

© 1993, 2021, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/17/docs/api/java.compiler/javax/annotation/processing/AbstractProcessor.html