Класс 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, связанный с этим путём.

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

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

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

forEach, iterator, 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 родителя