Интерфейс DocletEnvironment
public interface DocletEnvironment
Представляет рабочую среду одного вызова doclet. Этот объект можно использовать для доступа к структурам программы, различным служебным средствам и элементам, указанным пользователем в командной строке.
- Начиная с:
- 9
Краткое описание вложенных классов
| Модификатор и тип | Интерфейс | Описание |
|---|---|---|
static enum |
DocletEnvironment.ModuleMode |
Режим, задающий уровень детализации документации модулей. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
DocTrees |
getDocTrees() |
Возвращает экземпляр служебного класса DocTrees. |
Elements |
getElementUtils() |
Возвращает экземпляр служебного класса Elements. |
JavaFileObject.Kind |
getFileKind |
Возвращает вид файла элемента типа. |
Set |
getIncludedElements() |
Возвращает элементы модуля, пакета и типа, которые должны быть включены в документацию. |
JavaFileManager |
getJavaFileManager() |
Возвращает диспетчер файлов, используемый для чтения и записи файлов. |
DocletEnvironment.ModuleMode |
getModuleMode() |
Возвращает требуемый уровень документации модулей. |
SourceVersion |
getSourceVersion() |
Возвращает версию исходного кода файлов, которые были прочитаны. |
Set |
getSpecifiedElements() |
Возвращает элементы, указанные при вызове инструмента. |
Types |
getTypeUtils() |
Возвращает экземпляр служебного класса Types. |
boolean |
isIncluded |
Возвращает true, если элемент должен быть включен в документацию. |
boolean |
isSelected |
Возвращает true, если элемент выбран. |
Подробное описание методов
getSpecifiedElements
Set<? extends Element> getSpecifiedElements()
Возвращает элементы, указанные при вызове инструмента.
- Возвращает:
- набор указанных элементов
getIncludedElements
Set<? extends Element> getIncludedElements()
Возвращает элементы модуля, пакета и типа, которые должны быть включены в документацию.
- Возвращает:
- набор включенных элементов
getDocTrees
DocTrees getDocTrees()
Возвращает экземпляр служебного класса
DocTrees. Этот класс предоставляет методы для доступа к TreePaths, DocCommentTrees и так далее.- Возвращает:
- служебный класс для работы с деревьями документации
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, 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://docs.oracle.com/en/java/javase/25/docs/api/jdk.javadoc/jdk/javadoc/doclet/DocletEnvironment.html
