This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.annotation.processing
interface RoundEnvironment
public interface RoundEnvironment
An annotation processing tool framework will {@linkplain
Processor#process provide an annotation processor with an object
implementing this interface} so that the processor can query for
information about a round of annotation processing.
| Method Summary |
boolean |
Returns if an error was raised in the prior round
of processing; returns otherwise.
|
Set |
Returns the elements annotated with the given annotation type.
|
Set |
Returns the elements annotated with the given annotation type.
|
Set |
Returns the root elements for annotation processing generated
by the prior round.
|
boolean |
Returns if types generated by this round will not
be subject to a subsequent round of annotation processing;
returns otherwise.
|
errorRaised
public boolean errorRaised()
-
Returns {@code true} if an error was raised in the prior round
of processing; returns {@code false} otherwise.
- Returns:
- {@code true} if an error was raised in the prior round
of processing; returns {@code false} otherwise
getElementsAnnotatedWith
public Set getElementsAnnotatedWith(Class 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,
parameters, or type parameters declared within those, are
returned. Included type elements are {@linkplain
#getRootElements root types} and any member types nested within
them. Elements in a package are not considered included simply
because a {@code 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
getElementsAnnotatedWith
public Set 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,
parameters, or type parameters declared within those, are
returned. Included type elements are {@linkplain
#getRootElements root types} and any member types nested within
them. Elements in a package are not considered included simply
because a {@code 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
getRootElements
public Set 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
processingOver
public boolean processingOver()
-
Returns {@code true} if types generated by this round will not
be subject to a subsequent round of annotation processing;
returns {@code false} otherwise.
- Returns:
- {@code true} if types generated by this round will not
be subject to a subsequent round of annotation processing;
returns {@code false} otherwise
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.