| com.sun.mirror.apt.AnnotationProcessorEnvironment
All known Subclasses: org.eclipse.jdt.apt.core.internal.env.BaseProcessorEnv,
| AnnotationProcessorEnvironment | | public interface AnnotationProcessorEnvironment (Code) | | 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.
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 |
| addListener | | void addListener(AnnotationProcessorListener listener)(Code) | | Add a listener. If the listener is currently registered to listen,
adding it again will have no effect.
Parameters:
listener - The listener to add.
throws:
NullPointerException - if the listener is null |
| getDeclarationUtils | | Declarations getDeclarationUtils()(Code) | | Returns an implementation of some utility methods for
operating on declarations.
declaration utilities |
| getDeclarationsAnnotatedWith | | Collection<Declaration> getDeclarationsAnnotatedWith(AnnotationTypeDeclaration a)(Code) | | Returns the declarations annotated with the given annotation type.
Only declarations of the types
in this invocation of the annotation processing tool, or
declarations of members, parameters, or type parameters
declared within those, are returned.
Parameters:
a - annotation type being requested the declarations annotated with the given annotation type,or an empty collection if there are none |
| getFiler | | Filer getFiler()(Code) | | Returns the filer used to create new source, class, or auxiliary
files.
the filer |
| getMessager | | Messager getMessager()(Code) | | Returns the messager used to report errors, warnings, and other
notices.
the messager |
| getOptions | | Map<String, String> getOptions()(Code) | | 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.
the options passed to the tool |
| getPackage | | PackageDeclaration getPackage(String name)(Code) | | Returns the declaration of a package given its fully qualified name.
Parameters:
name - fully qualified package name, or "" for the unnamed package the declaration of the named package, or null if it cannotbe found |
| getSpecifiedTypeDeclarations | | Collection<TypeDeclaration> getSpecifiedTypeDeclarations()(Code) | | Returns the declarations of the types specified when the
annotation processing tool was invoked.
the types specified when the tool was invoked, or anempty collection if there were none |
| getTypeDeclaration | | TypeDeclaration getTypeDeclaration(String name)(Code) | | Returns the declaration of a type given its fully qualified name.
Parameters:
name - fully qualified type name the declaration of the named type, or null if it cannot befound |
| getTypeDeclarations | | Collection<TypeDeclaration> getTypeDeclarations()(Code) | | A convenience method that returns the declarations of the types
in this invocation of the annotation processing tool.
the declarations of the types included in this invocationof the tool, or an empty collection if there are none |
| getTypeUtils | | Types getTypeUtils()(Code) | | Returns an implementation of some utility methods for
operating on types.
type utilities |
| removeListener | | void removeListener(AnnotationProcessorListener listener)(Code) | | Remove a listener. If the listener is not currently listening,
the method call does nothing.
Parameters:
listener - The listener to remove.
throws:
NullPointerException - if the listener is null |
|
|