javax.annotation.processing

Интерфейсный ProcessingEnvironment

public interface ProcessingEnvironment

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

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

С тех пор:

1.6

Сводка метода

Методы

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

Деталь метода

getOptions

Map<String,String> getOptions()

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

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

Возвраты:

специфичные для процессора опции, которые передают к инструменту

getMessager

Messager getMessager()

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

Возвраты:

messager

getFiler

Filer getFiler()

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

Возвраты:

программа для работы с файлами

getElementUtils

Elements getElementUtils()

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

Возвраты:

утилиты элемента

getTypeUtils

Types getTypeUtils()

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

Возвраты:

введите утилиты

getSourceVersion

SourceVersion getSourceVersion()

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

Возвраты:

исходная версия, к которой сгенерированный источник и файлы класса должны соответствовать

См. Также:

Processor.getSupportedSourceVersion()

getLocale

Locale getLocale()

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

Возвраты:

текущая локаль или null если никакая локаль не в действительности