| com.sun.mirror.apt |
|
Classes used to communicate information between
{@linkplain com.sun.mirror.apt.AnnotationProcessor annotation processors}
and an annotation processing tool.
Note that the apt tool and its associated APIs may be
changed or superseded in future j2se releases.
@since 1.5
|
| Java Source File Name | Type | Comment |
| AnnotationProcessor.java | Interface | An annotation processor, used to examine and process the
annotations of program elements. |
| AnnotationProcessorEnvironment.java | Interface | 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. |
| AnnotationProcessorFactory.java | Interface | A factory for creating annotation processors.
Each factory is responsible for creating processors for one or more
annotation types.
The factory is said to support these types.
Each implementation of an AnnotationProcessorFactory
must provide a public no-argument constructor to be used by tools to
instantiate the factory.
author:
Joseph D. |
| AnnotationProcessorListener.java | Interface | Superinterface for all annotation processor event listeners.
author:
Joseph D. |
| AnnotationProcessors.java | Class | Utilities to create specialized annotation processors.
since:
1.5
author:
Joseph D. |
| Filer.java | Interface | This interface supports the creation of new files by an
annotation processor.
Files created in this way will be known to the annotation processing
tool implementing this interface, better enabling the tool to manage them.
Four kinds of files are distinguished:
source files, class files, other text files, and other binary files.
The latter two are collectively referred to as auxiliary files.
There are two distinguished locations (subtrees within the
file system) where newly created files are placed:
one for new source files, and one for new class files.
(These might be specified on a tool's command line, for example,
using flags such as -s and -d.)
Auxiliary files may be created in either location.
During each run of an annotation processing tool, a file
with a given pathname may be created only once. |
| Messager.java | Interface | A Messager provides the way for
an annotation processor to report error messages, warnings, and
other notices.
author:
Joseph D. |
| RoundCompleteEvent.java | Class | Event for the completion of a round of annotation processing.
While this class extends the serializable EventObject, it
cannot meaningfully be serialized because all of the annotation
processing tool's internal state would potentially be needed.
author:
Joseph D. |
| RoundCompleteListener.java | Interface | Listener for the completion of a round of annotation processing.
author:
Joseph D. |
| RoundState.java | Interface | Represents the status of a completed round of annotation processing.
author:
Joseph D. |