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.
|
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,
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. |
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. |
TreePath |
getTreePath() |
Returns the TreePath associated with this path.
|
Iterator<DocTree> |
iterator() |
Returns an iterator over elements of type
T . |
forEach, spliterator
public DocTreePath(DocTreePath p, DocTree t)
p
- the parent nodet
- the child nodepublic DocTreePath(TreePath treePath, DocCommentTree t)
treePath
- the TreePath from which the root node was created.t
- the DocCommentTree to create the path for.public static DocTreePath getPath(TreePath treePath, DocCommentTree doc, DocTree target)
null
if the node is not found.treePath
- the path for the node with which the doc comment is associateddoc
- the doc comment associated with the nodetarget
- a node within the doc commentpublic static DocTreePath getPath(DocTreePath path, DocTree target)
null
if the node is not found.path
- a path identifying a node within a doc comment treetarget
- a node to be located within the given nodepublic TreePath getTreePath()
public DocCommentTree getDocComment()
public DocTree getLeaf()
public DocTreePath getParentPath()
null
if there is no enclosing node.
Copyright © 2005, 2016, Oracle and/or its affiliates. All rights reserved.
DRAFT 9-Ubuntu+0-9b144-1ubuntu1