Интерфейс DocletEnvironment

public interface DocletEnvironment

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

Since:: 9

Вложенные классы

Модификатор и тип	Интерфейс	Описание
`static class`	`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:: тип файла