Класс 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(TreePath treePath, DocCommentTree t)`	Создаёт путь для корневого узла.

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

Модификатор и тип	Метод	Описание
`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)

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

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

DocTreePath

public DocTreePath(DocTreePath p, DocTree t)

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

Параметры:: 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()

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

Возвращает:: лист для этого 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://download.java.net/java/early_access/jdk24/docs/api/jdk.compiler/com/sun/source/util/DocTreePath.html