Spec-Zone.ru › OpenJDK 21

Интерфейс ProcessingEnvironment

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

Третьи лица могут захотеть предоставить оболочки для объектов в этом интерфейсе, например, расширение, которое позволит нескольким обработчикам координировать запись в один исходный файл. Для этого, чтобы обработчики, работающие в контексте, где их побочные эффекты через API могут быть видны друг другу, инфраструктура инструмента должна предоставлять соответствующие объекты утилит, которые являются .equals, Filers, которые являются .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:
  • Processor.getSupportedSourceVersion()

getLocale

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

isPreviewEnabled

default boolean isPreviewEnabled()
Возвращает true если функции предварительного просмотра включены, и false в противном случае.
Implementation Requirements:
Реализация по умолчанию этого метода возвращает false.
Returns:
включены ли функции предварительного просмотра
Since:
13

© 1993, 2023, 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/21/docs/api/java.compiler/javax/annotation/processing/ProcessingEnvironment.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API