モジュール jdk.compiler

パッケージ com.sun.source.util

インタフェースDocSourcePositions

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

SourcePositions

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)から返されるようにしてください。 返される位置は、このツリーの開始点である必要があります。つまり、このツリーのサブツリーでは、次の状態を保持する必要があります。

getStartPosition(file, comment, tree) <= getStartPosition(file, comment, subtree)または
getStartPosition(file, comment, tree) == NOPOSまたは
getStartPosition(file, comment, subtree) == NOPOS

パラメータ:

file - ツリーを検索するコンパイル・ユニット

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

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

戻り値:

ツリーの開始位置

getEndPosition

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

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

getEndPosition(file, comment, tree) >= getEndPosition(file, comment, subtree)または
getEndPosition(file, comment, tree) == NOPOSまたは
getEndPosition(file, comment, subtree) == NOPOS

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

getStartPosition(file, comment, tree) <= getEndPosition(file, comment, tree)または
getStartPosition(file, comment, tree) == NOPOSまたは
getEndPosition(file, comment, tree) == NOPOS

パラメータ:

file - ツリーを検索するコンパイル・ユニット

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

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

戻り値:

ツリーの終了位置