com.sun.source.util
インタフェース SourcePositions

public interface SourcePositions

CompilationUnit 内の Tree の部分を取得するためのメソッドを提供します。位置は CompilationUnit の開始点からの単純な文字オフセットとして定義されます。最初の文字は、オフセット 0 になります。

導入されたバージョン:

1.6

メソッドの概要

long	getEndPosition(CompilationUnitTree file, Tree tree) ファイル内のツリーの終了位置を取得します。
long	getStartPosition(CompilationUnitTree file, Tree tree) ファイル内のツリーの開始位置を取得します。

メソッドの詳細

getStartPosition

long getStartPosition(CompilationUnitTree file,
                      Tree tree)

ファイル内のツリーの開始位置を取得します。ツリーがファイル内に見つからない場合、または開始点が無効な場合、Diagnostic.NOPOS を返します。返される位置は、このツリーの開始点である必要があります。つまり、このツリーのサブツリーでは、次の状態を保持する必要があります。

tree.getStartPosition() <= subtree.getStartPosition() または
tree.getStartPosition() == NOPOS または
subtree.getStartPosition() == NOPOS

パラメータ:

file - ツリーが検索される CompilationUnit

tree - 位置のシーク対象となるツリー

戻り値:

ツリーの開始位置

getEndPosition

long getEndPosition(CompilationUnitTree file,
                    Tree tree)

ファイル内のツリーの終了位置を取得します。ツリーがファイル内に見つからない場合、または開始点が無効な場合、Diagnostic.NOPOS を返します。返される位置は、このツリーの終了点である必要があります。つまり、このツリーのサブツリーでは、次の状態を保持する必要があります。

tree.getEndPosition() >= subtree.getEndPosition() または
tree.getEndPosition() == NOPOS または
subtree.getEndPosition() == NOPOS

さらに、次の状態が保持されます。

tree.getStartPosition() <= tree.getEndPosition() または
tree.getStartPosition() == NOPOS または
tree.getEndPosition() == NOPOS

パラメータ:

file - ツリーが検索される CompilationUnit

tree - 位置のシーク対象となるツリー

戻り値:

ツリーの終了位置