File Doc Category Size Date Package
SourcePositions.java API Doc Java SE 6 API 2547 Tue Jun 10 00:23:26 BST 2008 com.sun.source.util

SourcePositions

public interface SourcePositions

Provides methods to obtain the position of a Tree within a CompilationUnit. A position is defined as a simple character offset from the start of a CompilationUnit where the first character is at offset 0.

author: Peter von der Ahé
since: 1.6

Fields Summary
Constructors Summary
Methods Summary
public long getEndPosition(com.sun.source.tree.CompilationUnitTree file, com.sun.source.tree.Tree tree)
Gets the ending position of tree within file. If tree is not found within file, or if the starting position is not available, return {@link 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:
{@code tree.getEndPosition() >= subtree.getEndPosition()} or
{@code tree.getEndPosition() == NOPOS} or
{@code subtree.getEndPosition() == NOPOS}
In addition, the following must hold:
{@code tree.getStartPosition() <= tree.getEndPosition()} or
{@code tree.getStartPosition() == NOPOS} or
{@code tree.getEndPosition() == NOPOS}
param
file CompilationUnit in which to find tree.
param
tree tree for which a position is sought.
return
the end position of tree.
public long getStartPosition(com.sun.source.tree.CompilationUnitTree file, com.sun.source.tree.Tree tree)
Gets the starting position of tree within file. If tree is not found within file, or if the starting position is not available, return {@link 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:
{@code tree.getStartPosition() <= subtree.getStartPosition()} or
{@code tree.getStartPosition() == NOPOS} or
{@code subtree.getStartPosition() == NOPOS}
param
file CompilationUnit in which to find tree.
param
tree tree for which a position is sought.
return
the start position of tree.