com.sun.source.util

インタフェースDocSourcePositions

すべてのスーパー・インタフェース:

SourcePositions

@Exported
public interface DocSourcePositions
extends SourcePositions

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

導入されたバージョン:

1.8

メソッドのサマリー

修飾子と型	メソッドと説明
long	getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) ファイル内のコメント内のツリーの終了位置を取得します。
long	getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) ファイル内のコメント内のツリーの開始位置を取得します。

インタフェース com.sun.source.util.SourcePositionsから継承されたメソッド

getEndPosition, getStartPosition

メソッドの詳細

getStartPosition

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

ファイル内のコメント内のツリーの開始位置を取得します。ツリーがファイル内に見つからない場合、または開始点が無効な場合、Diagnostic.NOPOSを返します。指定されたツリーは指定されたコメント・ツリーの下に配置し、指定されたドキュメンテーション・コメント・ツリーは、指定されたファイルの下にあるツリーのDocTrees.getDocCommentTree(com.sun.source.util.TreePath)から返されるようにしてください。返される位置は、このツリーの開始点である必要があります。つまり、このツリーのサブツリーでは、次の状態を保持する必要があります。

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

パラメータ:

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

comment - 位置のシーク対象となるツリーを囲むコメント・ツリー

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

戻り値:

ツリーの開始位置。

getEndPosition

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

ファイル内のコメント内のツリーの終了位置を取得します。ツリーがファイル内に見つからない場合、または終了点が無効な場合、Diagnostic.NOPOSを返します。指定されたツリーは指定されたコメント・ツリーの下に配置し、指定されたドキュメンテーション・コメント・ツリーは、指定されたファイルの下にあるツリーのDocTrees.getDocCommentTree(com.sun.source.util.TreePath)から返されるようにしてください。返される位置は、このツリーの終了点である必要があります。つまり、このツリーのサブツリーでは、次の状態を保持する必要があります。

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

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

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

パラメータ:

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

comment - 位置のシーク対象となるツリーを囲むコメント・ツリー

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

戻り値:

ツリーの開始位置。