Интерфейс 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()`	Возвращает реализацию некоторых служебных методов для работы с типами.
`default boolean`	`isPreviewEnabled()`	Возвращает `true`, если превью-функции включены, и `false` в противном случае.

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

getOptions

Map<String,String> getOptions()

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

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

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

getMessager

Messager getMessager()

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

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

getFiler

Filer getFiler()

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

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

getElementUtils

Elements getElementUtils()

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

Returns:: реализация некоторых служебных методов для работы с элементами

getTypeUtils

Types getTypeUtils()

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

Returns:: реализация некоторых служебных методов для работы с типами

getSourceVersion

SourceVersion getSourceVersion()

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

Returns:

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

See Also:

getLocale

Locale getLocale()

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

Returns:: текущая локали или null, если локали нет

isPreviewEnabled

default boolean isPreviewEnabled()

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

Implementation Requirements:

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

Returns:

включены ли превью-функции

Since:

See Also:

© 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://download.java.net/java/early_access/jdk24/docs/api/java.compiler/javax/annotation/processing/ProcessingEnvironment.html