ProcessingEnvironment JDK 1.6)

Description

public interface ProcessingEnvironment

An annotation processing tool framework will provide an annotation processor with an object implementing this interface so the processor can use facilities provided by the framework to write new files, report error messages, and find other utilities.

See also:

Methods

Hide/Show inherited methods

public Elements getElementUtils ()

Returns an implementation of some utility methods for operating on elements

public Filer getFiler ()

Returns the filer used to create new source, class, or auxiliary files.

public Locale getLocale ()

Returns the current locale or null if no locale is in effect.

Returns the current locale or null if no locale is in
effect. The locale can be be used to provide localized
messages.
Returns: the current locale or {@code null} if no locale is in effect

public Messager getMessager ()

Returns the messager used to report errors, warnings, and other notices.

public Map<String, String> getOptions ()

Returns the processor-specific options passed to the annotation processing tool.

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.
Returns: the processor-specific options passed to the tool

public SourceVersion getSourceVersion ()

Returns the source version that any generated source and class files should conform to.

public Types getTypeUtils ()

Returns an implementation of some utility methods for operating on types.