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

Method Summary

Modifier and Type	Method and Description
public default long	Returns: the end position of tree getEndPosition(CompilationUnitTree compilation unit in which to find tree file, DocCommentTree the comment tree that encloses the tree for which the position is being sought comment, DocTree tree for which a position is sought tree) Deprecated for removal since 27. use `getEndPosition(DocCommentTree, DocTree)` instead Returns the ending position of the tree within the comment within the file.
public long	Returns: the ending position of the given `Tree`. If the ending position is not available, returns `javax.tools.Diagnostic#NOPOS` getEndPosition(DocCommentTree the comment tree that encloses the tree for which the position is being sought comment, DocTree tree for which a position is sought tree) Returns the ending position of the given `Tree`.
public default long	Returns: the start position of tree getStartPosition(CompilationUnitTree compilation unit in which to find tree file, DocCommentTree the comment tree that encloses the tree for which the position is being sought comment, DocTree tree for which a position is sought tree) Deprecated for removal since 27. use `getStartPosition(DocCommentTree, DocTree)` instead Returns the starting position of the tree within the comment within the file.
public long	Returns: the starting position of the given `Tree`. If the starting position is not available, returns `javax.tools.Diagnostic#NOPOS` getStartPosition(DocCommentTree the comment tree that encloses the tree for which the position is being sought comment, DocTree tree for which a position is sought tree) Returns the starting position of the given `Tree`.

Inherited from com.sun.source.util.SourcePositions:: getEndPosition getEndPosition getStartPosition getStartPosition

Method Detail

getEndPosition back to summary

getEndPosition	back to summary
public default long getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) Deprecated for removal since 27. use `getEndPosition(DocCommentTree, DocTree)` instead Returns the ending position of the tree within the comment within the file. If tree is not found within file, or if the ending position is not available, returns `javax.tools.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` In addition, the following must hold: `getStartPosition(file, comment, tree) <= getEndPosition(file, comment, tree)` or `getStartPosition(file, comment, tree) == NOPOS` or `getEndPosition(file, comment, tree) == NOPOS` Parameters file:CompilationUnitTree compilation unit in which to find tree comment:DocCommentTree the comment tree that encloses the tree for which the position is being sought tree:DocTree tree for which a position is sought Returns:long the end position of tree Annotations @Deprecated since:27 forRemoval:true

public default long getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)

Deprecated

for removal since 27.

use getEndPosition(DocCommentTree, DocTree) instead

Returns the ending position of the tree within the comment within the file. If tree is not found within file, or if the ending position is not available, returns javax.tools.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

In addition, the following must hold:

getStartPosition(file, comment, tree) <= getEndPosition(file, comment, tree) or
getStartPosition(file, comment, tree) == NOPOS or
getEndPosition(file, comment, tree) == NOPOS

Parameters

file:CompilationUnitTree: compilation unit in which to find tree
comment:DocCommentTree: the comment tree that encloses the tree for which the position is being sought
tree:DocTree: tree for which a position is sought

Returns:long

the end position of tree

Annotations

@Deprecated
since:27
forRemoval:true

getEndPosition back to summary

getEndPosition	back to summary
public long getEndPosition(DocCommentTree comment, DocTree tree) Returns the ending position of the given `Tree`. If the ending position is not available, returns `javax.tools.Diagnostic#NOPOS`. The given tree should be under the given comment tree. 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(comment, tree) >= getEndPosition(comment, subtree)` or `getEndPosition(comment, tree) == NOPOS` or `getEndPosition(comment, subtree) == NOPOS` In addition, the following must hold: `getStartPosition(comment, tree) <= getEndPosition(comment, tree)` or `getStartPosition(comment, tree) == NOPOS` or `getEndPosition(comment, tree) == NOPOS` Parameters comment:DocCommentTree the comment tree that encloses the tree for which the position is being sought tree:DocTree tree for which a position is sought Returns:long the ending position of the given `Tree`. If the ending position is not available, returns `javax.tools.Diagnostic#NOPOS` Since 27

public long getEndPosition(DocCommentTree comment, DocTree tree)

Returns the ending position of the given Tree. If the ending position is not available, returns javax.tools.Diagnostic#NOPOS.

The given tree should be under the given comment tree. 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(comment, tree) >= getEndPosition(comment, subtree) or
getEndPosition(comment, tree) == NOPOS or
getEndPosition(comment, subtree) == NOPOS

In addition, the following must hold:

getStartPosition(comment, tree) <= getEndPosition(comment, tree) or
getStartPosition(comment, tree) == NOPOS or
getEndPosition(comment, tree) == NOPOS

Parameters

comment:DocCommentTree: the comment tree that encloses the tree for which the position is being sought
tree:DocTree: tree for which a position is sought

Returns:long

the ending position of the given Tree. If the ending position is not available, returns javax.tools.Diagnostic#NOPOS

Since

getStartPosition back to summary

getStartPosition	back to summary
public default long getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) Deprecated for removal since 27. use `getStartPosition(DocCommentTree, DocTree)` instead Returns the starting position of the tree within the comment within the file. If tree is not found within file, or if the starting position is not available, returns `javax.tools.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` Parameters file:CompilationUnitTree compilation unit in which to find tree comment:DocCommentTree the comment tree that encloses the tree for which the position is being sought tree:DocTree tree for which a position is sought Returns:long the start position of tree Annotations @Deprecated since:27 forRemoval:true

public default long getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree)

Deprecated

for removal since 27.

use getStartPosition(DocCommentTree, DocTree) instead

Returns the starting position of the tree within the comment within the file. If tree is not found within file, or if the starting position is not available, returns javax.tools.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

Parameters

file:CompilationUnitTree: compilation unit in which to find tree
comment:DocCommentTree: the comment tree that encloses the tree for which the position is being sought
tree:DocTree: tree for which a position is sought

Returns:long

the start position of tree

Annotations

@Deprecated
since:27
forRemoval:true

getStartPosition back to summary

getStartPosition	back to summary
public long getStartPosition(DocCommentTree comment, DocTree tree) Returns the starting position of the given `Tree`. If the starting position is not available, returns `javax.tools.Diagnostic#NOPOS`. The given tree should be under the given comment tree. 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(comment, tree) <= getStartPosition(comment, subtree)` or `getStartPosition(comment, tree) == NOPOS` or `getStartPosition(comment, subtree) == NOPOS` Parameters comment:DocCommentTree the comment tree that encloses the tree for which the position is being sought tree:DocTree tree for which a position is sought Returns:long the starting position of the given `Tree`. If the starting position is not available, returns `javax.tools.Diagnostic#NOPOS` Since 27

public long getStartPosition(DocCommentTree comment, DocTree tree)

Returns the starting position of the given Tree. If the starting position is not available, returns javax.tools.Diagnostic#NOPOS.

The given tree should be under the given comment tree. 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(comment, tree) <= getStartPosition(comment, subtree) or
getStartPosition(comment, tree) == NOPOS or
getStartPosition(comment, subtree) == NOPOS

Parameters

comment:DocCommentTree: the comment tree that encloses the tree for which the position is being sought
tree:DocTree: tree for which a position is sought

Returns:long

the starting position of the given Tree. If the starting position is not available, returns javax.tools.Diagnostic#NOPOS

Since

public Interface DocSourcePositions

Method Summary

Method Detail