| javax.annotation.processing.ProcessingEnvironment
All known Subclasses: com.sun.tools.javac.processing.JavacProcessingEnvironment,
| ProcessingEnvironment | | public interface ProcessingEnvironment (Code) | | An annotation processing tool framework will
so the processor can use facilities
provided by the framework to write new files, report error
messages, and find other utilities.
Third parties may wish to provide value-add wrappers around the
facility objects from this interface, for example a
Filer extension that allows multiple processors to coordinate writing out
a single source file. To enable this, for processors running in a
context where their side effects via the API could be visible to
each other, the tool infrastructure must provide corresponding
facility objects that are
.equals ,
Filer s that are
.equals , and so on. In addition, the tool invocation must
be able to be configured such that from the perspective of the
running annotation processors, at least the chosen subset of helper
classes are viewed as being loaded by the same class loader.
(Since the facility objects manage shared state, the implementation
of a wrapper class must know whether or not the same base facility
object has been wrapped before.)
author:
Joseph D. Darcy
author:
Scott Seligman
author:
Peter von der Ahé
version:
1.11 07/05/05
since:
1.6 |
| getElementUtils | | Elements getElementUtils()(Code) | | Returns an implementation of some utility methods for
operating on elements
element utilities |
| getFiler | | Filer getFiler()(Code) | | Returns the filer used to create new source, class, or auxiliary
files.
the filer |
| getLocale | | Locale getLocale()(Code) | | Returns the current locale or
null if no locale is in
effect. The locale can be be used to provide localized
.
the current locale or null if no locale is ineffect |
| 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 processor-specific options passed to the annotation
processing tool. Options are returned in the form of a map from
option name to option value. For an option with no value, the
corresponding value in the map is
null .
See documentation of the particular tool infrastructure
being used for details on how to pass in processor-specific
options. For example, a command-line implementation may
distinguish processor-specific options by prefixing them with a
known string like
"-A" ; other tool implementations may
follow different conventions or provide alternative mechanisms.
A given implementation may also provide implementation-specific
ways of finding options passed to the tool in addition to the
processor-specific options.
the processor-specific options passed to the tool |
| getTypeUtils | | Types getTypeUtils()(Code) | | Returns an implementation of some utility methods for
operating on types.
type utilities |
|
|