FileDocCategorySizeDatePackage
RoundEnvironment.javaAPI DocJava SE 6 API3746Tue Jun 10 00:26:04 BST 2008javax.annotation.processing

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.
author
Joseph D. Darcy
author
Scott Seligman
author
Peter von der Ahé
version
1.6 06/08/02
since
1.6

Fields Summary
Constructors Summary
Methods Summary
public booleanerrorRaised()
Returns {@code true} if an error was raised in the prior round of processing; returns {@code false} otherwise.

return
{@code true} if an error was raised in the prior round of processing; returns {@code false} otherwise

public java.util.SetgetElementsAnnotatedWith(javax.lang.model.element.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.

param
a annotation type being requested
return
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

public java.util.SetgetElementsAnnotatedWith(java.lang.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.

param
a annotation type being requested
return
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

public java.util.SetgetRootElements()
Returns the root elements for annotation processing generated by the prior round.

return
the root elements for annotation processing generated by the prior round, or an empty set if there were none

public booleanprocessingOver()
Returns {@code true} if types generated by this round will not be subject to a subsequent round of annotation processing; returns {@code false} otherwise.

return
{@code true} if types generated by this round will not be subject to a subsequent round of annotation processing; returns {@code false} otherwise