Интерфейс RoundEnvironment

Методы

processingOver

boolean processingOver()

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

Возвращает:

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

errorRaised

boolean errorRaised()

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

Возвращает:

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

getRootElements

Set<? extends Element> getRootElements()

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

Возвращает:

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

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 — если какие-либо элементы набора аргументов не представляют тип аннотации

С момента:

9

getElementsAnnotatedWith

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

getElementsAnnotatedWithAny

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

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

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

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

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

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

Параметры:

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

Возвращает:

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

Исключения:

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

С момента:

9