OpenJDK 27 · javax.annotation.processing.RoundEnvironment

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: `true` if an error was raised in the prior round of processing; returns `false` otherwise errorRaised() Returns `true` if an error was raised in the prior round of processing; returns `false` otherwise.
public Set<? extends Element>	Returns: the elements annotated with the given annotation interface, or an empty set if there are none getElementsAnnotatedWith(TypeElement annotation interface being requested a) Returns the elements annotated with the given annotation interface.
public Set<? extends Element>	Returns: the elements annotated with the given annotation interface, or an empty set if there are none getElementsAnnotatedWith(Class<? extends Annotation> annotation interface being requested a) Returns the elements annotated with the given annotation interface.
public default Set<? extends Element>	Returns: the elements annotated with one or more of the given annotation interfaces, or an empty set if there are none getElementsAnnotatedWithAny(TypeElement... annotation interfaces being requested annotations) Returns the elements annotated with one or more of the given annotation interfaces.
public default Set<? extends Element>	Returns: the elements annotated with one or more of the given annotation interfaces, or an empty set if there are none getElementsAnnotatedWithAny(Set<Class<? extends Annotation>> annotation interfaces being requested annotations) Returns the elements annotated with one or more of the given annotation interfaces.
public Set<? extends Element>	Returns: the root elements for annotation processing generated by the prior round, or an empty set if there were none getRootElements() Returns the root elements for annotation processing generated by the prior round.
public boolean	Returns: `true` if types generated by this round will not be subject to a subsequent round of annotation processing; returns `false` otherwise processingOver() Returns `true` if types generated by this round will not be subject to a subsequent round of annotation processing; returns `false` otherwise.

Method Detail

errorRaised back to summary

errorRaised	back to summary
public boolean errorRaised() Returns `true` if an error was raised in the prior round of processing; returns `false` otherwise. Returns:boolean `true` if an error was raised in the prior round of processing; returns `false` otherwise

public boolean errorRaised()

Returns true if an error was raised in the prior round of processing; returns false otherwise.

Returns:boolean: true if an error was raised in the prior round of processing; returns false otherwise

getElementsAnnotatedWith back to summary

getElementsAnnotatedWith	back to summary
public Set<? extends Element> getElementsAnnotatedWith(TypeElement a) Returns the elements annotated with the given annotation interface. The annotation may appear directly or be inherited. Only package elements, module elements, and type elements included in this round of annotation processing, or declarations of members, constructors, parameters, type parameters, or record components declared within those, are returned. Included type elements are root types and any member types nested within them. Elements of a package are not considered included simply because a `package-info` file for that package was created. Likewise, elements of a module are not considered included simply because a `module-info` file for that module was created. Parameters a:TypeElement annotation interface being requested Returns:Set<? extends Element> the elements annotated with the given annotation interface, or an empty set if there are none Exceptions IllegalArgumentException: if the argument does not represent an annotation interface

public Set<? extends Element> getElementsAnnotatedWith(TypeElement a)

Returns the elements annotated with the given annotation interface. The annotation may appear directly or be inherited. Only package elements, module elements, and type elements included in this round of annotation processing, or declarations of members, constructors, parameters, type parameters, or record components declared within those, are returned. Included type elements are root types and any member types nested within them. Elements of a package are not considered included simply because a package-info file for that package was created. Likewise, elements of a module are not considered included simply because a module-info file for that module was created.

Parameters

a:TypeElement: annotation interface being requested

Returns:Set<? extends Element>

the elements annotated with the given annotation interface, or an empty set if there are none

Exceptions

IllegalArgumentException:: if the argument does not represent an annotation interface

getElementsAnnotatedWith back to summary

getElementsAnnotatedWith	back to summary
public Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a) Returns the elements annotated with the given annotation interface. The annotation may appear directly or be inherited. Only package elements, module elements, and type elements included in this round of annotation processing, or declarations of members, constructors, parameters, type parameters, or record components declared within those, are returned. Included type elements are root types and any member types nested within them. Elements in a package are not considered included simply because a `package-info` file for that package was created. Likewise, elements of a module are not considered included simply because a `module-info` file for that module was created. Note An implementation of this method typically performs an internal conversion from the runtime reflective representation of an annotation interface as a `Class` object to a different representation used for annotation processing. The set of annotation interfaces present in the runtime context may differ from the set of annotation interfaces present in the context of annotation processing in a particular environmental configuration. If a runtime annotation interface is not present in the annotation processing context, the situation is not treated as an error and no elements are found for that annotation interface. Parameters a:Class<? extends Annotation> annotation interface being requested Returns:Set<? extends Element> the elements annotated with the given annotation interface, or an empty set if there are none Exceptions IllegalArgumentException: if the argument does not represent an annotation interface See Also `javax.lang.model.AnnotatedConstruct#getAnnotation(Class)`, `javax.lang.model.AnnotatedConstruct#getAnnotationsByType(Class)`

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

Returns the elements annotated with the given annotation interface. The annotation may appear directly or be inherited. Only package elements, module elements, and type elements included in this round of annotation processing, or declarations of members, constructors, parameters, type parameters, or record components declared within those, are returned. Included type elements are root types and any member types nested within them. Elements in a package are not considered included simply because a package-info file for that package was created. Likewise, elements of a module are not considered included simply because a module-info file for that module was created.

Note

An implementation of this method typically performs an internal conversion from the runtime reflective representation of an annotation interface as a Class object to a different representation used for annotation processing. The set of annotation interfaces present in the runtime context may differ from the set of annotation interfaces present in the context of annotation processing in a particular environmental configuration. If a runtime annotation interface is not present in the annotation processing context, the situation is not treated as an error and no elements are found for that annotation interface.

Parameters

a:Class<? extends Annotation>: annotation interface being requested

Returns:Set<? extends Element>

the elements annotated with the given annotation interface, or an empty set if there are none

Exceptions

IllegalArgumentException:: if the argument does not represent an annotation interface

getElementsAnnotatedWithAny back to summary

getElementsAnnotatedWithAny	back to summary
public default Set<? extends Element> getElementsAnnotatedWithAny(TypeElement... annotations) Returns the elements annotated with one or more of the given annotation interfaces. API Note This method may be useful when processing repeating annotations by looking for an annotation interface and its containing annotation interface at the same time. Implementation Specification The default implementation of this method creates an empty result set, iterates over the annotations in the argument array calling `getElementsAnnotatedWith(TypeElement)` on each annotation and adding those results to the result set. Finally, the contents of the result set are returned as an unmodifiable set. Parameters annotations:TypeElement[] annotation interfaces being requested Returns:Set<? extends Element> the elements annotated with one or more of the given annotation interfaces, or an empty set if there are none Exceptions IllegalArgumentException: if the any elements of the argument set do not represent an annotation interface Since 9 Java Language Specification 9.6.3 Repeatable Annotation Interfaces

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

Returns the elements annotated with one or more of the given annotation interfaces.

API Note

This method may be useful when processing repeating annotations by looking for an annotation interface and its containing annotation interface at the same time.

Implementation Specification

The default implementation of this method creates an empty result set, iterates over the annotations in the argument array calling getElementsAnnotatedWith(TypeElement) on each annotation and adding those results to the result set. Finally, the contents of the result set are returned as an unmodifiable set.

Parameters

annotations:TypeElement[]: annotation interfaces being requested

Returns:Set<? extends Element>

the elements annotated with one or more of the given annotation interfaces, or an empty set if there are none

Exceptions

IllegalArgumentException:: if the any elements of the argument set do not represent an annotation interface

Since

Java Language Specification

9.6.3 Repeatable Annotation Interfaces

getElementsAnnotatedWithAny back to summary

getElementsAnnotatedWithAny	back to summary
public default Set<? extends Element> getElementsAnnotatedWithAny(Set<Class<? extends Annotation>> annotations) Returns the elements annotated with one or more of the given annotation interfaces. Note An implementation of this method typically performs an internal conversion from the runtime reflective representation of an annotation interface as a `Class` object to a different representation used for annotation processing. The set of annotation interfaces present in the runtime context may differ from the set of annotation interfaces present in the context of annotation processing in a particular environmental configuration. If a runtime annotation interface is not present in the annotation processing context, the situation is not treated as an error and no elements are found for that annotation interface. API Note This method may be useful when processing repeating annotations by looking for an annotation interface and its containing annotation interface at the same time. Implementation Specification The default implementation of this method creates an empty result set, iterates over the annotations in the argument set calling `getElementsAnnotatedWith(Class)` on each annotation and adding those results to the result set. Finally, the contents of the result set are returned as an unmodifiable set. Parameters annotations:Set<Class<? extends Annotation>> annotation interfaces being requested Returns:Set<? extends Element> the elements annotated with one or more of the given annotation interfaces, or an empty set if there are none Exceptions IllegalArgumentException: if the any elements of the argument set do not represent an annotation interface Since 9 Java Language Specification 9.6.3 Repeatable Annotation Interfaces See Also `javax.lang.model.AnnotatedConstruct#getAnnotation(Class)`, `javax.lang.model.AnnotatedConstruct#getAnnotationsByType(Class)`

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

Returns the elements annotated with one or more of the given annotation interfaces.

Note

API Note

This method may be useful when processing repeating annotations by looking for an annotation interface and its containing annotation interface at the same time.

Implementation Specification

The default implementation of this method creates an empty result set, iterates over the annotations in the argument set calling getElementsAnnotatedWith(Class) on each annotation and adding those results to the result set. Finally, the contents of the result set are returned as an unmodifiable set.

Parameters

annotations:Set<Class<? extends Annotation>>: annotation interfaces being requested

Returns:Set<? extends Element>

the elements annotated with one or more of the given annotation interfaces, or an empty set if there are none

Exceptions

IllegalArgumentException:: if the any elements of the argument set do not represent an annotation interface

Since

Java Language Specification

9.6.3 Repeatable Annotation Interfaces

getRootElements	back to summary
public Set<? extends Element> getRootElements() Returns the root elements for annotation processing generated by the prior round. API Note Root elements correspond to the top-level declarations in compilation units (JLS section 7.3). Root elements are most commonly types, but can also be packages or modules. Returns:Set<? extends Element> the root elements for annotation processing generated by the prior round, or an empty set if there were none

getRootElements

back to summary

public Set<? extends Element> getRootElements()

Returns the root elements for annotation processing generated by the prior round.

API Note

Root elements correspond to the top-level declarations in compilation units (JLS section 7.3). Root elements are most commonly types, but can also be packages or modules.

Returns:Set<? extends Element>: the root elements for annotation processing generated by the prior round, or an empty set if there were none

processingOver back to summary

processingOver	back to summary
public boolean processingOver() Returns `true` if types generated by this round will not be subject to a subsequent round of annotation processing; returns `false` otherwise. Returns:boolean `true` if types generated by this round will not be subject to a subsequent round of annotation processing; returns `false` otherwise

public boolean processingOver()

Returns true if types generated by this round will not be subject to a subsequent round of annotation processing; returns false otherwise.

Returns:boolean: true if types generated by this round will not be subject to a subsequent round of annotation processing; returns false otherwise

public Interface RoundEnvironment

Method Summary

Method Detail