Интерфейс ProcessingEnvironment

public interface ProcessingEnvironment

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

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

Начиная с:: 1.6

Краткое описание методов

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

Подробное описание методов

getOptions

Map<String,String> getOptions()

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

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

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

getMessager

Messager getMessager()

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

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

getFiler

Filer getFiler()

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

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

getElementUtils

Elements getElementUtils()

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

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

getTypeUtils

Types getTypeUtils()

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

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

getSourceVersion

SourceVersion getSourceVersion()

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

Возвращает:

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

См. также:

getLocale

Locale getLocale()

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

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

isPreviewEnabled

default boolean isPreviewEnabled()

Возвращает true, если включены предварительные функции, и false в противном случае.

Требования к реализации:

Реализация этого метода по умолчанию возвращает false.

Возвращает:

включены ли предварительные функции

Начиная с:

См. также:

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/25/docs/api/java.compiler/javax/annotation/processing/ProcessingEnvironment.html