Interface ProcessingEnvironment
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.)
- Since:
- 1.6
- 
Method SummaryModifier and TypeMethodDescriptionReturns an implementation of some utility methods for operating on elements.getFiler()Returns the filer used to create new source, class, or auxiliary files.Returns the current locale ornullif no locale is in effect.Returns the messager used to report errors, warnings, and other notices.Returns the processor-specific options passed to the annotation processing tool.Returns an implementation of some utility methods for operating on types.default booleanReturnstrueif preview features are enabled andfalseotherwise.
- 
Method Details- 
getOptionsReturns 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 isnull.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.- Returns:
- the processor-specific options passed to the annotation processing tool
 
- 
getMessagerMessager getMessager()Returns the messager used to report errors, warnings, and other notices.- Returns:
- the messager used to report errors, warnings, and other notices
 
- 
getFilerFiler getFiler()Returns the filer used to create new source, class, or auxiliary files.- Returns:
- the filer used to create new source, class, or auxiliary files
 
- 
getElementUtilsElements getElementUtils()Returns an implementation of some utility methods for operating on elements.- Returns:
- an implementation of some utility methods for operating on elements
 
- 
getTypeUtilsTypes getTypeUtils()Returns an implementation of some utility methods for operating on types.- Returns:
- an implementation of some utility methods for operating on types
 
- 
getSourceVersionSourceVersion getSourceVersion()
- 
getLocale
- 
isPreviewEnableddefault boolean isPreviewEnabled()Returnstrueif preview features are enabled andfalseotherwise.- Implementation Requirements:
- The default implementation of this method returns
 false.
- Returns:
- whether or not preview features are enabled
- Since:
- 13
- See Also:
 
 
-