Module jdk.compiler

Package com.sun.source.util

Class DocTreePath

java.lang.Object

com.sun.source.util.DocTreePath

All Implemented Interfaces:

Iterable<DocTree>

public class DocTreePath
extends Object
implements Iterable<DocTree>

A path of tree nodes, typically used to represent the sequence of ancestor nodes of a tree node up to the top-level DocCommentTree node.

Since:

1.8

Constructor Summary

Constructors

Constructor	Description
DocTreePath(DocTreePath p, DocTree t)	Creates a DocTreePath for a child node.
DocTreePath(TreePath treePath, DocCommentTree t)	Creates a DocTreePath for a root node.

Method Summary

Modifier and Type

Method

Description

DocCommentTree

getDocComment()

Returns the DocCommentTree associated with this path.

DocTree

getLeaf()

Returns the leaf node for this path.

DocTreePath

getParentPath()

Returns the path for the enclosing node, or null if there is no enclosing node.

static DocTreePath

getPath(DocTreePath path,