Класс 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`.

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

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

Методы, объявленные в интерфейсе 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, 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.compiler/com/sun/source/util/DocTreePath.html