SourcePositions
public interface DocSourcePositions extends SourcePositions
Modifier and Type | Method | Description |
---|---|---|
long |
getEndPosition |
Returns the ending position of the tree within the comment within the file. |
long |
getStartPosition |
Returns 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: getStartPosition(file, comment, tree) <= getStartPosition(file, comment, subtree)
or
getStartPosition(file, comment, tree) == NOPOS
or
getStartPosition(file, comment, subtree) == NOPOS
file
- compilation unit in which to find treecomment
- the comment tree that encloses the tree for which the position is being soughttree
- tree for which a position is soughtlong 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: getEndPosition(file, comment, tree) >= getEndPosition(file, comment, subtree)
or
getEndPosition(file, comment, tree) == NOPOS
or
getEndPosition(file, comment, subtree) == NOPOS
getStartPosition(file, comment, tree) <= getEndPosition(file, comment, tree)
or
getStartPosition(file, comment, tree) == NOPOS
or
getEndPosition(file, comment, tree) == NOPOS
file
- compilation unit in which to find treecomment
- the comment tree that encloses the tree for which the position is being soughttree
- tree for which a position is sought
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.compiler/com/sun/source/util/DocSourcePositions.html