@Exported public interface DocSourcePositions extends SourcePositions
Modifier and Type | Method and Description |
---|---|
long |
getEndPosition(CompilationUnitTree file,
DocCommentTree comment,
DocTree tree)
Gets the ending position of the tree within the comment within the file.
|
long |
getStartPosition(CompilationUnitTree file,
DocCommentTree comment,
DocTree tree)
Gets the starting position of the tree within the comment within the file.
|
getEndPosition, getStartPosition
long getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)
Diagnostic.NOPOS
.
The given tree should be under the given comment tree, and the given documentation
comment tree should be returned from a DocTrees.getDocCommentTree(com.sun.source.util.TreePath)
for a tree under the given file.
The returned position must be at the start of the yield of this tree, that
is for any sub-tree of this tree, the following must hold:
tree.getStartPosition() <= subtree.getStartPosition()
or
tree.getStartPosition() == NOPOS
or
subtree.getStartPosition() == NOPOS
file
- CompilationUnit in which to find tree.comment
- the comment tree that encloses the tree for which the
position is being soughttree
- tree for which a position is sought.long getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)
Diagnostic.NOPOS
.
The given tree should be under the given comment tree, and the given documentation
comment tree should be returned from a DocTrees.getDocCommentTree(com.sun.source.util.TreePath)
for a tree under the given file.
The returned position must be at the end of the yield of this tree,
that is for any sub-tree of this tree, the following must hold:
tree.getEndPosition() >= subtree.getEndPosition()
or
tree.getEndPosition() == NOPOS
or
subtree.getEndPosition() == NOPOS
tree.getStartPosition() <= tree.getEndPosition()
or
tree.getStartPosition() == NOPOS
or
tree.getEndPosition() == NOPOS
file
- CompilationUnit in which to find tree.comment
- the comment tree that encloses the tree for which the
position is being soughttree
- tree for which a position is sought.
Copyright © 2005, 2014, Oracle and/or its affiliates. All rights reserved.