Интерфейс DocletEnvironment

public interface DocletEnvironment

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

Since:: 9

Краткое описание вложенных классов

Модификатор и тип	Интерфейс	Описание
`static enum`	`DocletEnvironment.ModuleMode`	Режим, определяющий уровень детализации документации модуля.

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

Модификатор и тип	Метод	Описание
`DocTrees`	`getDocTrees()`	Возвращает экземпляр класса утилиты `DocTrees`.
`Elements`	`getElementUtils()`	Возвращает экземпляр класса утилиты `Elements`.
`JavaFileObject.Kind`	`getFileKind(TypeElement type)`	Возвращает тип файла для элемента типа.
`Set<? extends Element>`	`getIncludedElements()`	Возвращает элементы модуля, пакета и типа, которые должны быть включены в документацию.
`JavaFileManager`	`getJavaFileManager()`	Возвращает менеджер файлов, используемый для чтения и записи файлов.
`DocletEnvironment.ModuleMode`	`getModuleMode()`	Возвращает требуемый уровень документации модуля.
`SourceVersion`	`getSourceVersion()`	Возвращает версию исходного кода прочитанных исходных файлов.
`Set<? extends Element>`	`getSpecifiedElements()`	Возвращает элементы, указанные при вызове инструмента.
`Types`	`getTypeUtils()`	Возвращает экземпляр класса утилиты `Types`.
`boolean`	`isIncluded(Element e)`	Возвращает true, если элемент должен быть включен в документацию.
`boolean`	`isSelected(Element e)`	Возвращает true, если элемент выбран.

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

getSpecifiedElements

Set<? extends Element> getSpecifiedElements()

Возвращает элементы, указанные при вызове инструмента.

Returns:: множество указанных элементов

getIncludedElements

Set<? extends Element> getIncludedElements()

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

Returns:: множество включенных элементов

getDocTrees

DocTrees getDocTrees()

Возвращает экземпляр класса утилиты DocTrees. Этот класс предоставляет методы для доступа к TreePath и DocCommentTree, и т.д.

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

getElementUtils

Elements getElementUtils()

Возвращает экземпляр класса утилиты Elements . Этот класс предоставляет методы для работы с elements.

Returns:: класс утилит для работы с элементами

getTypeUtils

Types getTypeUtils()

Возвращает экземпляр класса утилиты Types . Этот класс предоставляет методы для работы с type mirrors.

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

isIncluded

boolean isIncluded(Element e)

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

Parameters:: e - элемент
Returns:: true, если включен, иначе false

isSelected

boolean isSelected(Element e)

Возвращает true, если элемент выбран.

Parameters:: e - элемент
Returns:: true, если выбран, иначе false

getJavaFileManager

JavaFileManager getJavaFileManager()

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

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

getSourceVersion

SourceVersion getSourceVersion()

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

Returns:: версия исходного кода

getModuleMode

DocletEnvironment.ModuleMode getModuleMode()

Возвращает требуемый уровень документации модуля.

Returns:: требуемый уровень документации модуля

getFileKind

JavaFileObject.Kind getFileKind(TypeElement type)

Возвращает тип файла для элемента типа.

Parameters:: type - элемент типа
Returns:: тип файла

© 1993, 2021, 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/17/docs/api/jdk.javadoc/jdk/javadoc/doclet/DocletEnvironment.html