模块 jdk.compiler

软件包 com.sun.source.util

Interface DocSourcePositions

All Superinterfaces:

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)为给定文件下的树返回给定的文档注释树。 返回的位置必须位于此树的yield的开头，即对于此树的任何子树，必须满足以下条件：

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)为给定文件下的树返回给定的文档注释树。 返回的位置必须位于此树的yield的末尾，即对于此树的任何子树，必须满足以下条件：

tree.getEndPosition() >= subtree.getEndPosition()或
tree.getEndPosition() == NOPOS或
subtree.getEndPosition() == NOPOS

此外，必须具备以下条件：

tree.getStartPosition() <= tree.getEndPosition()或
tree.getStartPosition() == NOPOS或
tree.getEndPosition() == NOPOS

参数

file - 用于查找树的CompilationUnit。

comment - 包含正在寻找位置的树的注释树

tree - 寻求职位的树。

结果

树的起始位置。