Интерфейс 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()

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

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

getIncludedElements

Set<? extends Element> getIncludedElements()

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

Возвращает:: множество включённых элементов

getDocTrees

DocTrees getDocTrees()

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

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

getElementUtils

Elements getElementUtils()

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

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

getTypeUtils

Types getTypeUtils()

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

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

isIncluded

boolean isIncluded(Element e)

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

Параметры:: e - элемент
Возвращает:: true, если включён, false иначе

isSelected

boolean isSelected(Element e)

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

Параметры:: e - элемент
Возвращает:: true, если выбран, false иначе

getJavaFileManager

JavaFileManager getJavaFileManager()

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

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

getSourceVersion

SourceVersion getSourceVersion()

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

Возвращает:: версия исходного кода

getModuleMode

DocletEnvironment.ModuleMode getModuleMode()

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

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

getFileKind

JavaFileObject.Kind getFileKind(TypeElement type)

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

Параметры:: type - элемент типа
Возвращает:: тип файла

© 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/jdk.javadoc/jdk/javadoc/doclet/DocletEnvironment.html