Класс 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()`	Возвращает имена интерфейсов аннотаций, поддерживаемых этим процессором.
`Set<String>`	`getSupportedOptions()`	Возвращает параметры, распознаваемые этим процессором.
`SourceVersion`	`getSupportedSourceVersion()`	Возвращает последнюю версию исходного кода, поддерживаемую этим процессором аннотаций.
`void`	`init(ProcessingEnvironment processingEnv)`	Инициализирует процессор средой обработки.
`protected boolean`	`isInitialized()`	Возвращает `true`, если этот объект был инициализирован, и `false` в противном случае.
`abstract boolean`	`process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)`	Обрабатывает набор интерфейсов аннотаций для корневых элементов, полученных в предыдущем раунде, и возвращает, считает ли этот процессор эти интерфейсы аннотаций обработанными.

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

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()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`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. Если этот метод вызывается для одного и того же объекта более одного раза, будет выброшено исключение IllegalStateException.
Параметры:: processingEnv — среда для доступа к средствам, которые инструментальная платформа предоставляет процессору
Выбрасывает:: IllegalStateException — если этот метод вызывается более одного раза.

process

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

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


true

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

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

© 1993, 2025, 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.