FileDocCategorySizeDatePackage
AnnotationProcessorEnvironment.javaAPI DocJava SE 5 API5030Fri Aug 26 14:55:14 BST 2005com.sun.mirror.apt

AnnotationProcessorEnvironment

public interface AnnotationProcessorEnvironment
The environment encapsulating the state needed by an annotation processor. An annotation processing tool makes this environment available to all annotation processors.

When an annotation processing tool is invoked, it is given a set of type declarations on which to operate. These are refered to as the specified types. The type declarations said to be included in this invocation consist of the specified types and any types nested within them.

{@link DeclarationFilter} provides a simple way to select just the items of interest when a method returns a collection of declarations.

author
Joseph D. Darcy
author
Scott Seligman
version
1.7 04/07/19
since
1.5

Fields Summary
Constructors Summary
Methods Summary
public voidaddListener(com.sun.mirror.apt.AnnotationProcessorListener listener)
Add a listener. If the listener is currently registered to listen, adding it again will have no effect.

param
listener The listener to add.
throws
NullPointerException if the listener is null

public com.sun.mirror.util.DeclarationsgetDeclarationUtils()
Returns an implementation of some utility methods for operating on declarations.

return
declaration utilities

public java.util.CollectiongetDeclarationsAnnotatedWith(com.sun.mirror.declaration.AnnotationTypeDeclaration a)
Returns the declarations annotated with the given annotation type. Only declarations of the types {@linkplain AnnotationProcessorEnvironment included} in this invocation of the annotation processing tool, or declarations of members, parameters, or type parameters declared within those, are returned.

param
a annotation type being requested
return
the declarations annotated with the given annotation type, or an empty collection if there are none

public com.sun.mirror.apt.FilergetFiler()
Returns the filer used to create new source, class, or auxiliary files.

return
the filer

public com.sun.mirror.apt.MessagergetMessager()
Returns the messager used to report errors, warnings, and other notices.

return
the messager

public java.util.MapgetOptions()
Returns the options passed to the annotation processing tool. Options are returned in the form of a map from option name (such as "-encoding") to option value. For an option with no value (such as "-help"), the corresponding value in the map is null.

Options beginning with "-A" are processor-specific. Such options are unrecognized by the tool, but intended to be used by some annotation processor.

return
the options passed to the tool

public com.sun.mirror.declaration.PackageDeclarationgetPackage(java.lang.String name)
Returns the declaration of a package given its fully qualified name.

param
name fully qualified package name, or "" for the unnamed package
return
the declaration of the named package, or null if it cannot be found

public java.util.CollectiongetSpecifiedTypeDeclarations()
Returns the declarations of the types specified when the annotation processing tool was invoked.

return
the types specified when the tool was invoked, or an empty collection if there were none

public com.sun.mirror.declaration.TypeDeclarationgetTypeDeclaration(java.lang.String name)
Returns the declaration of a type given its fully qualified name.

param
name fully qualified type name
return
the declaration of the named type, or null if it cannot be found

public java.util.CollectiongetTypeDeclarations()
A convenience method that returns the declarations of the types {@linkplain AnnotationProcessorEnvironment included} in this invocation of the annotation processing tool.

return
the declarations of the types included in this invocation of the tool, or an empty collection if there are none

public com.sun.mirror.util.TypesgetTypeUtils()
Returns an implementation of some utility methods for operating on types.

return
type utilities

public voidremoveListener(com.sun.mirror.apt.AnnotationProcessorListener listener)
Remove a listener. If the listener is not currently listening, the method call does nothing.

param
listener The listener to remove.
throws
NullPointerException if the listener is null