Интерфейс RoundEnvironment

public interface RoundEnvironment

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

Начиная с:: 1.6

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

Модификатор и тип	Метод	Описание
`boolean`	`errorRaised()`	Возвращает `true`, если в предыдущем раунде обработки была обнаружена ошибка; в противном случае возвращает `false`.
`Set<? extends Element>`	`getElementsAnnotatedWith(Class<? extends Annotation> a)`	Возвращает элементы, аннотированные заданным интерфейсом аннотации.
`Set<? extends Element>`	`getElementsAnnotatedWith(TypeElement a)`	Возвращает элементы, аннотированные заданным интерфейсом аннотации.
`default Set<? extends Element>`	`getElementsAnnotatedWithAny(Set<Class<? extends Annotation>> annotations)`	Возвращает элементы, аннотированные одним или несколькими заданными интерфейсами аннотаций.
`default Set<? extends Element>`	`getElementsAnnotatedWithAny(TypeElement... annotations)`	Возвращает элементы, аннотированные одним или несколькими заданными интерфейсами аннотаций.
`Set<? extends Element>`	`getRootElements()`	Возвращает корневые элементы, созданные генерацией при обработке аннотаций в предыдущем раунде.
`boolean`	`processingOver()`	Возвращает `true`, если типы, созданные в этом раунде, не будут обрабатываться в последующем раунде обработки аннотаций; в противном случае возвращает `false`.

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

processingOver

boolean processingOver()

Возвращает true, если типы, созданные в этом раунде, не будут обрабатываться в последующем раунде обработки аннотаций; в противном случае возвращает false.

Возвращает:: true, если типы, созданные в этом раунде, не будут обрабатываться в последующем раунде обработки аннотаций; в противном случае возвращает false

errorRaised

boolean errorRaised()

Возвращает true, если в предыдущем раунде обработки была обнаружена ошибка; в противном случае возвращает false.

Возвращает:: true, если в предыдущем раунде обработки была обнаружена ошибка; в противном случае возвращает false

getRootElements

Set<? extends Element> getRootElements()

Возвращает корневые элементы, созданные генерацией при обработке аннотаций в предыдущем раунде.

Примечание API:: Корневые элементы соответствуют объявлениям верхнего уровня в единицах компиляции (раздел 7.3 JLS). Как правило, корневыми элементами являются типы, но ими также могут быть пакеты или модули.
Возвращает:: корневые элементы, созданные при обработке аннотаций в предыдущем раунде, или пустое множество, если таких элементов нет

getElementsAnnotatedWith

Set<? extends Element> getElementsAnnotatedWith(TypeElement a)

Возвращает элементы, аннотированные заданным интерфейсом аннотации. Аннотация может присутствовать непосредственно или наследоваться. Возвращаются только элементы пакетов, элементы модулей и элементы типов, включённые в этот раунд обработки аннотаций, а также объявления членов, конструкторов, параметров, параметров типа или компонентов записи, объявленные внутри них. К включённым элементам типов относятся корневые типы и все вложенные в них типы-члены. Элементы пакета не считаются включёнными только потому, что был создан файл package-info для этого пакета. Аналогично, элементы модуля не считаются включёнными только потому, что был создан файл module-info для этого модуля.

Параметры:: a — запрашиваемый интерфейс аннотации
Возвращает:: элементы, аннотированные заданным интерфейсом аннотации, или пустое множество, если таких элементов нет
Исключения:: IllegalArgumentException — если аргумент не представляет интерфейс аннотации

getElementsAnnotatedWithAny

default Set<? extends Element> getElementsAnnotatedWithAny(TypeElement... annotations)

Возвращает элементы, аннотированные одним или несколькими заданными интерфейсами аннотаций.

Примечание API:: Этот метод может быть полезен при обработке повторяющихся аннотаций, когда одновременно выполняется поиск интерфейса аннотации и содержащего его интерфейса аннотации.
Требования к реализации:: Реализация этого метода по умолчанию создаёт пустое множество результатов, перебирает аннотации в массиве аргументов, вызывая для каждой аннотации getElementsAnnotatedWith(TypeElement) и добавляя полученные результаты в множество. Затем содержимое множества результатов возвращается в виде неизменяемого множества.
Параметры:: annotations — запрашиваемые интерфейсы аннотаций
Возвращает:: элементы, аннотированные одним или несколькими заданными интерфейсами аннотаций, или пустое множество, если таких элементов нет
Исключения:: IllegalArgumentException — если какой-либо элемент множества аргументов не представляет интерфейс аннотации
См. Спецификацию языка Java:: 9.6.3 Повторяемые интерфейсы аннотаций
Начиная с:: 9

getElementsAnnotatedWith

Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a)

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

Параметры:

a — запрашиваемый интерфейс аннотации

Возвращает:

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

Исключения:

IllegalArgumentException — если аргумент не представляет интерфейс аннотации

См. также:

getElementsAnnotatedWithAny

default Set<? extends Element> getElementsAnnotatedWithAny(Set<Class<? extends Annotation>> annotations)

Возвращает элементы, аннотированные одним или несколькими заданными интерфейсами аннотаций.

Примечание API:

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

Требования к реализации:

Реализация этого метода по умолчанию создаёт пустое множество результатов, перебирает аннотации в множестве аргументов, вызывая для каждой аннотации getElementsAnnotatedWith(Class) и добавляя полученные результаты в множество. Затем содержимое множества результатов возвращается в виде неизменяемого множества.

Параметры:

annotations — запрашиваемые интерфейсы аннотаций

Возвращает:

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

Исключения:

IllegalArgumentException — если какой-либо элемент множества аргументов не представляет интерфейс аннотации

См. Спецификацию языка Java:

9.6.3 Повторяемые интерфейсы аннотаций

Начиная с:

См. также:

© 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.compiler/javax/annotation/processing/RoundEnvironment.html