Класс DocTrees

java.lang.Object

com.sun.source.util.Trees

com.sun.source.util.DocTrees

public abstract class DocTrees extends Trees

Предоставляет доступ к синтаксическим деревьям для комментариев к документации.

Since:: 1.8

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

Конструктор	Описание
`DocTrees()`	Конструктор для вызова подклассами.

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

Модификатор и тип	Метод	Описание
`abstract BreakIterator`	`getBreakIterator()`	Возвращает итератор разбиения, используемый для вычисления первого предложения комментариев к документации.
`abstract String`	`getCharacters(EntityTree tree)`	Возвращает строку, содержащую символы для сущности в заданном дереве сущностей, или `null` если дерево не представляет собой допустимую последовательность символов.
`abstract DocCommentTree`	`getDocCommentTree(TreePath path)`	Возвращает дерево комментариев к документации, если оно есть, для узла дерева, идентифицированного заданным TreePath.
`abstract DocCommentTree`	`getDocCommentTree(Element e)`	Возвращает дерево комментариев к документации заданного элемента.
`abstract DocCommentTree`	`getDocCommentTree(Element e, String relativePath)`	Возвращает дерево комментариев к документации заданного файла, путь которого указан относительно заданного элемента.
`abstract DocCommentTree`	`getDocCommentTree(FileObject fileObject)`	Возвращает дерево комментариев к документации заданного файла.
`abstract DocTreeFactory`	`getDocTreeFactory()`	Возвращает вспомогательный объект для создания `DocTree` объектов.
`abstract DocTreePath`	`getDocTreePath(FileObject fileObject, PackageElement packageElement)`	Возвращает путь к дереву документации, содержащий дерево комментариев к документации заданного файла.
`abstract Element`	`getElement(DocTreePath path)`	Возвращает элемент модели языка, на который ссылается лист узла заданного `DocTreePath`, или `null` если неизвестно.
`abstract List<DocTree>`	`getFirstSentence(List<? extends DocTree> list)`	Возвращает список `DocTree`, представляющих первое предложение комментария.
`abstract DocSourcePositions`	`getSourcePositions()`	Возвращает вспомогательный объект для доступа к позициям исходного кода узлов дерева документации.
`abstract TypeMirror`	`getType(DocTreePath path)`	Возвращает тип модели языка, на который ссылается лист узла заданного `DocTreePath`, или `null` если неизвестно.
`static DocTrees`	`instance(ProcessingEnvironment env)`	Возвращает объект DocTrees для заданной ProcessingEnvironment.
`static DocTrees`	`instance(JavaCompiler.CompilationTask task)`	Возвращает объект DocTrees для заданной CompilationTask.
`abstract void`	`printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)`	Выводит сообщение указанного типа в позиции дерева в предоставленном файле компиляции.
`abstract void`	`setBreakIterator(BreakIterator breakIterator)`	Устанавливает итератор разбиения для вычисления первого предложения комментариев к документации.

Методы, объявленные в классе com.sun.source.util.Trees

getDocComment, getElement, getLub, getOriginalType, getPath, getPath, getPath, getPath, getScope, getTree, getTree, getTree, getTree, getTree, getTypeMirror, isAccessible, isAccessible, printMessage

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

DocTrees

public DocTrees()

Конструктор для вызова подклассами.

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

instance

public static DocTrees instance(JavaCompiler.CompilationTask task)

Возвращает объект DocTrees для заданной CompilationTask.

Параметры:: task - задача компиляции, для которой требуется получить объект Trees
Возвращает:: объект DocTrees
Исключения:: IllegalArgumentException - если задача не поддерживает API Trees.

instance

public static DocTrees instance(ProcessingEnvironment env)

Возвращает объект DocTrees для заданной ProcessingEnvironment.

Параметры:: env - среда обработки, для которой требуется получить объект Trees
Возвращает:: объект DocTrees
Исключения:: IllegalArgumentException - если среда не поддерживает API Trees.

getBreakIterator

public abstract BreakIterator getBreakIterator()

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

Возвращает:: разделитель
С версии:: 9

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(TreePath path)

Возвращает дерево комментариев к документации, если оно есть, для узла дерева, идентифицируемого заданным TreePath. Возвращает null , если комментарий к документации не найден.

Примечание реализации:: Стандартная реализация этого метода возвращает тот же DocCommentTree экземпляр для повторных вызовов с тем же аргументом.
Параметры:: path - путь к узлу дерева
Возвращает:: дерево комментариев к документации

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(Element e)

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

Примечание реализации:: Стандартная реализация этого метода возвращает тот же DocCommentTree экземпляр для повторных вызовов с тем же аргументом.
Параметры:: e - элемент, документация которого требуется
Возвращает:: дерево комментариев к документации
С версии:: 9

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(FileObject fileObject)

Возвращает дерево комментариев к документации данного файла. Файл должен быть файлом HTML, в этом случае дерево комментариев к документации представляет собой все содержимое файла. Возвращает null , если комментарий к документации не найден. Будущие релизы могут поддерживать дополнительные типы файлов.

Примечание реализации:: Стандартная реализация этого метода возвращает новый DocCommentTree экземпляр для каждого вызова.
Параметры:: fileObject - контейнер с содержимым
Возвращает:: дерево комментариев к документации
С версии:: 9

getDocCommentTree

public abstract DocCommentTree getDocCommentTree(Element e, String relativePath) throws IOException

Возвращает дерево комментариев к документации данного файла, путь к которому указан относительно данного элемента. Файл должен быть файлом HTML, в этом случае дерево комментариев к документации представляет содержимое тега <body>, и любые окружающие теги игнорируются. Возвращает null , если комментарий к документации не найден. Будущие релизы могут поддерживать дополнительные типы файлов.

Примечание реализации:: Стандартная реализация этого метода возвращает новый DocCommentTree экземпляр для каждого вызова.
Параметры:: e - элемент, чья директория используется в качестве ссылки; relativePath - относительный путь от элемента
Возвращает:: дерево комментариев к документации
Исключения:: IOException - если произошла ошибка
С версии:: 9

getDocTreePath

public abstract DocTreePath getDocTreePath(FileObject fileObject, PackageElement packageElement)

Возвращает путь к дереву документации, содержащий дерево комментариев к документации данного файла. Файл должен быть файлом HTML, в этом случае дерево комментариев к документации представляет собой содержимое тега <body> , и любые окружающие теги игнорируются. Все ссылки на элементы исходного кода, содержащиеся в тегах @see и {@link} в дереве комментариев к документации, будут оцениваться в контексте заданного элемента пакета. Возвращает null , если комментарий к документации не найден.

Параметры:: fileObject - объект файла, содержащий HTML-содержимое; packageElement - элемент пакета, который нужно связать с данным объектом файла, представляющим собой устаревший пакет.html, null в противном случае
Возвращает:: путь к дереву документации, содержащий дерево комментариев, распарсенное из данного файла
Исключения:: IllegalArgumentException - если fileObject не является файлом HTML
С версии:: 9

getElement

public abstract Element getElement(DocTreePath path)

Возвращает элемент языка модели, на который ссылается лист узла заданного DocTreePath, или null , если неизвестно.

Параметры:: path - путь к узлу дерева
Возвращает:: элемент

getType

public abstract TypeMirror getType(DocTreePath path)

Возвращает тип языка модели, на который ссылается лист узла заданного DocTreePath, или null , если неизвестно. Этот метод обычно возвращает то же значение, что и getElement(path).asType() для аргумента path , для которого getElement(DocTreePath) возвращает ненулевое значение, но может возвращать тип, содержащий дополнительную информацию, например, параметризованный обобщенный тип вместо базового типа.

Параметры:: path - путь к узлу дерева
Возвращает:: ссылочный тип или null
С версии:: 15

getFirstSentence

public abstract List<DocTree> getFirstSentence(List<? extends DocTree> list)

Возвращает список DocTree , представляющих первую фразу комментария.

Параметры:: list - список DocTree для проверки
Возвращает:: первая фраза
С версии:: 9

getSourcePositions

public abstract DocSourcePositions getSourcePositions()

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

Определено в:: getSourcePositions в классе Trees
Возвращает:: объект утилиты

printMessage

public abstract void printMessage(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root)

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

Параметры:: kind - тип сообщения; msg - сообщение или пустая строка, если его нет; t - дерево для использования в качестве подсказки позиции; c - дерево комментариев к документации для использования в качестве подсказки позиции; root - единица компиляции, содержащая дерево

setBreakIterator

public abstract void setBreakIterator(BreakIterator breakIterator)

Устанавливает разделитель для вычисления первой фразы в комментариях к документации.

Параметры:: breakIterator - разделитель или null для указания стандартного разделителя фраз
С версии:: 9

getDocTreeFactory

public abstract DocTreeFactory getDocTreeFactory()

Возвращает утилиту для создания объектов DocTree .

Возвращает:: объект утилиты для создания объектов DocTree
С версии:: 9

getCharacters

public abstract String getCharacters(EntityTree tree)

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

Интерпретация сущностей основана на разделе 8.1.4. Ссылок на символы в спецификации HTML 5.2.

Параметры:

tree - дерево, содержащее сущность

Возвращает:

строка, содержащая символы

Внешние спецификации

© 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.compiler/com/sun/source/util/DocTrees.html