OpenJDK 27 · com.sun.source.util.DocTreePath · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final DocCommentTree	docComment
private final DocTree	leaf
private final DocTreePath	parent
private final TreePath	treePath

Constructor Summary

Access	Constructor and Description
public	DocTreePath(TreePath the `TreePath` from which the root node was created treePath, DocCommentTree the `DocCommentTree` to create the path for t) Creates a `DocTreePath` for a root node.
public	DocTreePath(DocTreePath the parent node p, DocTree the child node t) Creates a `DocTreePath` for a child node.

Method Summary

Modifier and Type	Method and Description
public DocCommentTree	Returns: the `DocCommentTree` for this `DocTreePath` getDocComment() Returns the `DocCommentTree` associated with this path.
public DocTree	Returns: the `DocTree` for this `DocTreePath` getLeaf() Returns the leaf node for this path.
public DocTreePath	Returns: `DocTreePath` of parent getParentPath() Returns the path for the enclosing node, or `null` if there is no enclosing node.
public static DocTreePath	Returns: a path identifying the target within the tree getPath(TreePath the path for the node with which the doc comment is associated treePath, DocCommentTree the doc comment associated with the node doc, DocTree a node within the doc comment target) Returns a documentation tree path for a tree node within a compilation unit, or `null` if the node is not found.
public static DocTreePath	Returns: a path identifying the target node getPath(DocTreePath a path identifying a node within a doc comment tree path, DocTree a node to be located within the given node target) Returns a documentation tree path for a tree node within a subtree identified by a `DocTreePath` object, or `null` if the node is not found.
public TreePath	Returns: the `TreePath` for this `DocTreePath` getTreePath() Returns the `TreePath` associated with this path.
public Iterator<DocTree>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

docComment	back to summary
private final DocCommentTree docComment

leaf	back to summary
private final DocTree leaf

parent	back to summary
private final DocTreePath parent

treePath	back to summary
private final TreePath treePath

Constructor Detail

DocTreePath back to summary

DocTreePath	back to summary
public DocTreePath(TreePath treePath, DocCommentTree t) Creates a `DocTreePath` for a root node. Parameters treePath:TreePath the `TreePath` from which the root node was created t:DocCommentTree the `DocCommentTree` to create the path for

public DocTreePath(TreePath treePath, DocCommentTree t)

Creates a DocTreePath for a root node.

Parameters

treePath:TreePath: the TreePath from which the root node was created
t:DocCommentTree: the DocCommentTree to create the path for

DocTreePath back to summary

DocTreePath	back to summary
public DocTreePath(DocTreePath p, DocTree t) Creates a `DocTreePath` for a child node. Parameters p:DocTreePath the parent node t:DocTree the child node

public DocTreePath(DocTreePath p, DocTree t)

Creates a DocTreePath for a child node.

Parameters

p:DocTreePath: the parent node
t:DocTree: the child node

Method Detail

getDocComment back to summary

getDocComment	back to summary
public DocCommentTree getDocComment() Returns the `DocCommentTree` associated with this path. Returns:DocCommentTree the `DocCommentTree` for this `DocTreePath`

public DocCommentTree getDocComment()

Returns the DocCommentTree associated with this path.

Returns:DocCommentTree: the DocCommentTree for this DocTreePath

getLeaf back to summary

getLeaf	back to summary
public DocTree getLeaf() Returns the leaf node for this path. Returns:DocTree the `DocTree` for this `DocTreePath`

public DocTree getLeaf()

Returns the leaf node for this path.

Returns:DocTree: the DocTree for this DocTreePath

getParentPath back to summary

getParentPath	back to summary
public DocTreePath getParentPath() Returns the path for the enclosing node, or `null` if there is no enclosing node. Returns:DocTreePath `DocTreePath` of parent

public DocTreePath getParentPath()

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

Returns:DocTreePath: DocTreePath of parent

getPath back to summary

getPath	back to summary
public static DocTreePath getPath(TreePath treePath, DocCommentTree doc, DocTree target) Returns a documentation tree path for a tree node within a compilation unit, or `null` if the node is not found. Parameters treePath:TreePath the path for the node with which the doc comment is associated doc:DocCommentTree the doc comment associated with the node target:DocTree a node within the doc comment Returns:DocTreePath a path identifying the target within the tree

public static DocTreePath getPath(TreePath treePath, DocCommentTree doc, DocTree target)

Returns a documentation tree path for a tree node within a compilation unit, or null if the node is not found.

Parameters

treePath:TreePath: the path for the node with which the doc comment is associated
doc:DocCommentTree: the doc comment associated with the node
target:DocTree: a node within the doc comment

Returns:DocTreePath

a path identifying the target within the tree

getPath back to summary

getPath	back to summary
public static DocTreePath getPath(DocTreePath path, DocTree target) Returns a documentation tree path for a tree node within a subtree identified by a `DocTreePath` object, or `null` if the node is not found. Parameters path:DocTreePath a path identifying a node within a doc comment tree target:DocTree a node to be located within the given node Returns:DocTreePath a path identifying the target node

public static DocTreePath getPath(DocTreePath path, DocTree target)

Returns a documentation tree path for a tree node within a subtree identified by a DocTreePath object, or null if the node is not found.

Parameters

path:DocTreePath: a path identifying a node within a doc comment tree
target:DocTree: a node to be located within the given node

Returns:DocTreePath

a path identifying the target node

getTreePath back to summary

getTreePath	back to summary
public TreePath getTreePath() Returns the `TreePath` associated with this path. Returns:TreePath the `TreePath` for this `DocTreePath`

public TreePath getTreePath()

Returns the TreePath associated with this path.

Returns:TreePath: the TreePath for this DocTreePath

iterator back to summary

iterator	back to summary
public Iterator<DocTree> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Annotations @Override

public Iterator<DocTree> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Annotations

@Override

public Class DocTreePath

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail