Класс 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, 2021, 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/17/docs/api/jdk.compiler/com/sun/source/util/DocTreePath.html