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, Filers 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.)
| Modifier and Type | Method and Description |
|---|---|
| public Elements | Returns: an implementation of some utility methods for operating on elementsReturns an implementation of some utility methods for operating on elements. |
| public Filer | Returns: the filer used to create new source, class, or auxiliary filesReturns the filer used to create new source, class, or auxiliary files. |
| public Locale | Returns: the current locale ornull if no locale is in
effectReturns the current locale or |
| public Messager | Returns: the messager used to report errors, warnings, and other noticesReturns the messager used to report errors, warnings, and other notices. |
| public Map | Returns: the processor-specific options passed to the annotation processing toolReturns the processor-specific options passed to the annotation processing tool. |
| public SourceVersion | getSourceVersion()
Returns the source version that any generated source and class files should conform to. |
| public Types | Returns: an implementation of some utility methods for operating on typesReturns an implementation of some utility methods for operating on types. |
| public default boolean | Returns: whether or not preview features are enabledReturns |
| getElementUtils | back to summary |
|---|---|
| public Elements getElementUtils() Returns an implementation of some utility methods for operating on elements.
| |
| getFiler | back to summary |
|---|---|
| public Filer getFiler() Returns the filer used to create new source, class, or auxiliary files.
| |
| getLocale | back to summary |
|---|---|
| public Locale getLocale() Returns the current locale or
| |
| getMessager | back to summary |
|---|---|
| public Messager getMessager() Returns the messager used to report errors, warnings, and other notices.
| |
| getOptions | back to summary |
|---|---|
| public Map 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 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 | |
| getSourceVersion | back to summary |
|---|---|
| public SourceVersion getSourceVersion() Returns the source version that any generated source and class files should conform to.
| |
| getTypeUtils | back to summary |
|---|---|
| public Types getTypeUtils() Returns an implementation of some utility methods for operating on types.
| |
| isPreviewEnabled | back to summary |
|---|---|
| public default boolean isPreviewEnabled() Returns Implementation Specification The default implementation of this method returns
| |
