Spec-Zone.ru › OpenJDK 8

Интерфейс ProcessingEnvironment


public interface ProcessingEnvironment

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

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

Since:
1.6

Методы

Модификатор и тип Метод и описание
Elements getElementUtils()

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

Filer getFiler()

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

Locale getLocale()

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

Messager getMessager()

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

Map<String,String> getOptions()

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

SourceVersion getSourceVersion()

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

Types getTypeUtils()

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

Методы

getOptions

Map<String,String> getOptions()

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

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

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

getMessager

Messager getMessager()

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

Возвращает:
messager

getFiler

Filer getFiler()

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

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

getElementUtils

Elements getElementUtils()

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

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

getTypeUtils

Types getTypeUtils()

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

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

getSourceVersion

SourceVersion getSourceVersion()

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

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

getLocale

Locale getLocale()

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

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

© 1993, 2020, 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.

Spec-Zone.ru

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