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

Method Summary

Modifier and Type	Method and Description
public default long	Returns: the end position of tree getEndPosition(CompilationUnitTree CompilationUnit in which to find tree file, Tree tree for which a position is sought tree) Deprecated for removal since 27. use `getEndPosition(Tree)` instead Returns the ending position of tree within file.
public long	Returns: the ending position of the given `Tree`. If the ending position is not available, returns `javax.tools.Diagnostic#NOPOS` getEndPosition(Tree 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 CompilationUnit in which to find tree file, Tree tree for which a position is sought tree) Deprecated for removal since 27. use `getStartPosition(Tree)` instead Returns the starting position of tree within file.
public long	Returns: the starting position of the given `Tree`, or if the starting position is not available, returns `javax.tools.Diagnostic#NOPOS` getStartPosition(Tree tree for which a position is sought tree) Returns the starting position of the given `Tree`, or if the starting position is not available, returns `javax.tools.Diagnostic#NOPOS`.

Method Detail

getEndPosition back to summary

getEndPosition	back to summary
public default long getEndPosition(CompilationUnitTree file, Tree tree) Deprecated for removal since 27. use `getEndPosition(Tree)` instead Returns the ending position of tree within file. If tree is not found within file, or if the ending position is not available, returns `javax.tools.Diagnostic#NOPOS`. 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, tree) >= getEndPosition(file, subtree)` or `getEndPosition(file, tree) == NOPOS` or `getEndPosition(file, subtree) == NOPOS` In addition, the following must hold: `getStartPosition(file, tree) <= getEndPosition(file, tree)` or `getStartPosition(file, tree) == NOPOS` or `getEndPosition(file, tree) == NOPOS` Parameters file:CompilationUnitTree CompilationUnit in which to find tree tree:Tree 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, Tree tree)

Deprecated

for removal since 27.

use getEndPosition(Tree) instead

Returns the ending position of tree within file. If tree is not found within file, or if the ending position is not available, returns javax.tools.Diagnostic#NOPOS. 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, tree) >= getEndPosition(file, subtree) or
getEndPosition(file, tree) == NOPOS or
getEndPosition(file, subtree) == NOPOS

In addition, the following must hold:

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

Parameters

file:CompilationUnitTree: CompilationUnit in which to find tree
tree:Tree: 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(Tree tree) Returns the ending position of the given `Tree`. If the ending position is not available, returns `javax.tools.Diagnostic#NOPOS`. 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(tree) >= getEndPosition(subtree)` or `getEndPosition(tree) == NOPOS` or `getEndPosition(subtree) == NOPOS` In addition, the following must hold: `getStartPosition(tree) <= getEndPosition(tree)` or `getStartPosition(tree) == NOPOS` or `getEndPosition(tree) == NOPOS` Parameters tree:Tree 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(Tree tree)

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

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(tree) >= getEndPosition(subtree) or
getEndPosition(tree) == NOPOS or
getEndPosition(subtree) == NOPOS

In addition, the following must hold:

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

Parameters

tree:Tree: 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, Tree tree) Deprecated for removal since 27. use `getStartPosition(Tree)` instead Returns the starting position of tree within file. If tree is not found within file, or if the starting position is not available, returns `javax.tools.Diagnostic#NOPOS`. 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, tree) <= getStartPosition(file, subtree)` or `getStartPosition(file, tree) == NOPOS` or `getStartPosition(file, subtree) == NOPOS` Parameters file:CompilationUnitTree CompilationUnit in which to find tree tree:Tree 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, Tree tree)

Deprecated

for removal since 27.

use getStartPosition(Tree) instead

Returns the starting position of tree within file. If tree is not found within file, or if the starting position is not available, returns javax.tools.Diagnostic#NOPOS. 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, tree) <= getStartPosition(file, subtree) or
getStartPosition(file, tree) == NOPOS or
getStartPosition(file, subtree) == NOPOS

Parameters

file:CompilationUnitTree: CompilationUnit in which to find tree
tree:Tree: 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(Tree tree) Returns the starting position of the given `Tree`, or if the starting position is not available, returns `javax.tools.Diagnostic#NOPOS`. 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(tree) <= getStartPosition(subtree)` or `getStartPosition(tree) == NOPOS` or `getStartPosition(subtree) == NOPOS` Parameters tree:Tree tree for which a position is sought Returns:long the starting position of the given `Tree`, or if the starting position is not available, returns `javax.tools.Diagnostic#NOPOS` Since 27

public long getStartPosition(Tree tree)

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

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(tree) <= getStartPosition(subtree) or
getStartPosition(tree) == NOPOS or
getStartPosition(subtree) == NOPOS

Parameters

tree:Tree: tree for which a position is sought

Returns:long

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

Since

public Interface SourcePositions

Method Summary

Method Detail