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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Показывает, равен ли этот объект какому-либо другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация устарела и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно посредством вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно посредством вызова notify или interrupt, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно посредством вызова notify или interrupt, либо до истечения заданного промежутка реального времени.

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

forEach, spliterator

Модификатор и тип	Метод	Описание
`default void`	`forEach(Consumer<? super DocTree> action)`	Выполняет указанное действие для каждого элемента `Iterable`, пока не будут обработаны все элементы или действие не вызовет исключение.
`default Spliterator<DocTree>`	`spliterator()`	Создает `Spliterator` для элементов, описанных этим `Iterable`.

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

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.