Класс DocTreePath

java.lang.Object

com.sun.source.util.DocTreePath

Все реализуемые интерфейсы:: Iterable<DocTree>

public class DocTreePath extends Object implements Iterable<DocTree>

Путь по узлам дерева, обычно используемый для представления последовательности родительских узлов узла дерева до корневого DocCommentTree узла.

С момента:: 1.8

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

Конструктор	Описание
`DocTreePath(DocTreePath p, DocTree t)`	Создаёт `DocTreePath` для дочернего узла.
`DocTreePath(TreePath treePath, DocCommentTree t)`	Создаёт `DocTreePath` для корневого узла.

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

Модификатор и тип	Метод	Описание
`DocCommentTree`	`getDocComment()`	Возвращает `DocCommentTree`, связанный с этим путём.
`DocTree`	`getLeaf()`	Возвращает лист узла для этого пути.
`DocTreePath`	`getParentPath()`	Возвращает путь для узла-контейнера или `null` если узла-контейнера нет.
`static DocTreePath`	`getPath(DocTreePath path, DocTree target)`	Возвращает путь документационного дерева для узла дерева внутри поддерева, идентифицируемого объектом `DocTreePath`, или `null`, если узел не найден.
`static DocTreePath`	`getPath(TreePath treePath, DocCommentTree doc, DocTree target)`	Возвращает путь документационного дерева для узла дерева внутри единицы компиляции, или `null` если узел не найден.
`TreePath`	`getTreePath()`	Возвращает `TreePath` связанный с этим путём.
`Iterator<DocTree>`	`iterator()`	Возвращает итератор над элементами типа `T`.

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

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

Методы, объявленные в интерфейсе java.lang.Iterable

forEach, spliterator

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

DocTreePath

public DocTreePath(TreePath treePath, DocCommentTree t)

Создаёт DocTreePath для корневого узла.

Параметры:: treePath - TreePath из которого был создан корневой узел; t - DocCommentTree для которого необходимо создать путь

DocTreePath

public DocTreePath(DocTreePath p, DocTree t)

Создаёт DocTreePath для дочернего узла.

Параметры:: p - родительский узел; t - дочерний узел

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

getPath

public static DocTreePath getPath(TreePath treePath, DocCommentTree doc, DocTree target)

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

Параметры:: treePath - путь к узлу, с которым связан комментарий документации; doc - комментарий документации, связанный с узлом; target - узел внутри комментария документации
Возвращает:: путь, определяющий целевой элемент в дереве

getPath

public static DocTreePath getPath(DocTreePath path, DocTree target)

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

Параметры:: path - путь, идентифицирующий узел внутри дерева комментариев документации; target - узел, который необходимо найти внутри данного узла
Возвращает:: путь, определяющий целевой узел

getTreePath

public TreePath getTreePath()

Возвращает TreePath, связанный с этим путём.

Возвращает:: TreePath для этого DocTreePath

getDocComment

public DocCommentTree getDocComment()

Возвращает DocCommentTree, связанный с этим путём.

Возвращает:: DocCommentTree для этого DocTreePath

getLeaf

public DocTree getLeaf()

Возвращает лист узла для этого пути.

Возвращает:: DocTree для этого DocTreePath

getParentPath

public DocTreePath getParentPath()

Возвращает путь для узла-контейнера, или null если узла-контейнера нет.

Возвращает:: DocTreePath родительского узла

iterator

public Iterator<DocTree> iterator()

Описание скопировано из интерфейса: Iterable

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

Определено в:: iterator в интерфейсе Iterable<DocTree>
Возвращает:: итератор.

© 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/DocTreePath.html