-
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
-
-
Method Summary
Methods Modifier and Type Method and Description boolean
errorRaised()
Returnstrue
if an error was raised in the prior round of processing; returnsfalse
otherwise.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()
Returnstrue
if types generated by this round will not be subject to a subsequent round of annotation processing; returnsfalse
otherwise.
-
-
-
Method Detail
-
processingOver
boolean processingOver()
Returnstrue
if types generated by this round will not be subject to a subsequent round of annotation processing; returnsfalse
otherwise.- Returns:
true
if types generated by this round will not be subject to a subsequent round of annotation processing; returnsfalse
otherwise
-
errorRaised
boolean errorRaised()
Returnstrue
if an error was raised in the prior round of processing; returnsfalse
otherwise.- Returns:
true
if an error was raised in the prior round of processing; returnsfalse
otherwise
-
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 apackage-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 apackage-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
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/annotation/processing/RoundEnvironment.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.