Interface RoundEnvironment
public interface RoundEnvironment
An annotation processing tool framework will provide an annotation processor with an object implementing this interface so that the processor can query for information about a round of annotation processing.
- Since:
- 1.6
Methods
| Modifier and Type | Method and Description |
|---|---|
boolean |
errorRaised() Returns |
Set<? extends Element> |
getElementsAnnotatedWith(Class<? extends Annotation> a) Returns the elements annotated with the given annotation type. |
Set<? extends Element> |
getElementsAnnotatedWith(TypeElement a) Returns the elements annotated with the given annotation type. |
Set<? extends Element> |
getRootElements() Returns the root elements for annotation processing generated by the prior round. |
boolean |
processingOver() Returns |
Methods
processingOver
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:
-
trueif types generated by this round will not be subject to a subsequent round of annotation processing; returnsfalseotherwise
errorRaised
boolean errorRaised()
Returns true if an error was raised in the prior round of processing; returns false otherwise.
- Returns:
-
trueif an error was raised in the prior round of processing; returnsfalseotherwise
getRootElements
Set<? extends Element> getRootElements()
Returns the root elements for annotation processing generated by the prior round.
- Returns:
- the root elements for annotation processing generated by the prior round, or an empty set if there were none
getElementsAnnotatedWith
Set<? extends Element> getElementsAnnotatedWith(TypeElement a)
Returns the elements annotated with the given annotation type. The annotation may appear directly or be inherited. Only package elements and type elements included in this round of annotation processing, or declarations of members, constructors, parameters, or type parameters 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.
- Parameters:
-
a- annotation type being requested - Returns:
- the elements annotated with the given annotation type, or an empty set if there are none
- Throws:
-
IllegalArgumentException- if the argument does not represent an annotation type
getElementsAnnotatedWith
Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a)
Returns the elements annotated with the given annotation type. The annotation may appear directly or be inherited. Only package elements and type elements included in this round of annotation processing, or declarations of members, constructors, parameters, or type parameters 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.
- Parameters:
-
a- annotation type being requested - Returns:
- the elements annotated with the given annotation type, or an empty set if there are none
- Throws:
-
IllegalArgumentException- if the argument does not represent an annotation type
© 1993, 2020, 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/javase/8/docs/api/javax/annotation/processing/RoundEnvironment.html