Интерфейс ProcessingEnvironment

public interface ProcessingEnvironment

Фреймворк инструментария для обработки аннотаций предоставит обработчику аннотаций объект, реализующий этот интерфейс, чтобы обработчик мог использовать возможности, предоставляемые фреймворком, для записи новых файлов, сообщения об ошибках и поиска других утилит.

Третьи стороны могут захотеть предоставить обертки с добавленной ценностью над объектами-объектами из этого интерфейса, например, расширение Filer, которое позволяет нескольким обработчикам координировать запись одного исходного файла. Для этого, для обработчиков, работающих в контексте, где их побочные эффекты через API могут быть видны друг другу, инфраструктура инструмента должна предоставлять соответствующие объекты-объекты, которые являются .equals, Filer, которые .equals, и так далее. Кроме того, вызов инструмента должен быть настроен таким образом, чтобы с точки зрения работающих обработчиков аннотаций, по крайней мере, выбранный подмножество вспомогательных классов рассматривалось как загруженное одним и тем же загрузчиком классов. (Поскольку объекты-объекты управляют общим состоянием, реализация класса-обертки должна знать, обернут ли один и тот же базовый объект-объект ранее или нет.)

Since:: 1.6

Методы

Модификатор и тип	Метод	Описание
`Elements`	`getElementUtils()`	Возвращает реализацию некоторых утилит для работы с элементами
`Filer`	`getFiler()`	Возвращает фильтр, используемый для создания новых исходных, классных или вспомогательных файлов.
`Locale`	`getLocale()`	Возвращает текущий локали или `null`, если локали нет.
`Messager`	`getMessager()`	Возвращает средство сообщений, используемое для сообщения об ошибках, предупреждениях и других уведомлениях.
`Map<String,String>`	`getOptions()`	Возвращает специфичные для обработчика параметры, переданные инструменту обработки аннотаций.
`SourceVersion`	`getSourceVersion()`	Возвращает версию исходного кода, которой должны соответствовать все созданные исходные и классовые файлы.
`Types`	`getTypeUtils()`	Возвращает реализацию некоторых утилит для работы с типами.

Методы

getOptions

Map<String,String> getOptions()

Возвращает параметры, специфичные для обработчика, переданные инструменту обработки аннотаций. Параметры возвращаются в виде карты из имени параметра к значению параметра. Для параметра без значения соответствующее значение в карте — null.

См. документацию по используемой инфраструктуре инструмента для получения подробностей о том, как передавать параметры, специфичные для обработчика. Например, реализация командной строки может различать параметры, специфичные для обработчика, добавляя к ним известную строку, как "-A"; другие реализации инструмента могут следовать различным соглашениям или предоставлять альтернативные механизмы. Конкретная реализация также может предоставить способы поиска параметров, переданных инструменту, в дополнение к параметрам, специфичным для обработчика.

Возвращает:: параметры, специфичные для обработчика, переданные инструменту

getMessager

Messager getMessager()

Возвращает средство сообщений, используемое для сообщения об ошибках, предупреждениях и других уведомлениях.

Возвращает:: средство сообщений

getFiler

Filer getFiler()

Возвращает фильтр, используемый для создания новых исходных, классных или вспомогательных файлов.

Возвращает:: фильтр

getElementUtils

Elements getElementUtils()

Возвращает реализацию некоторых утилит для работы с элементами

Возвращает:: утилиты элементов

getTypeUtils

Types getTypeUtils()

Возвращает реализацию некоторых утилит для работы с типами.

Возвращает:: утилиты типов

getSourceVersion

SourceVersion getSourceVersion()

Возвращает версию исходного кода, которой должны соответствовать все созданные исходные и классовые файлы.

Возвращает:: версию исходного кода, которой должны соответствовать созданные исходные и классовые файлы
См. также:: Processor.getSupportedSourceVersion()

getLocale

Locale getLocale()

Возвращает текущий локали или null, если локали нет. Локали можно использовать для предоставления локализованных сообщений.

Возвращает:: текущий локали или null, если локали нет