Module jdk.compiler
Package com.sun.source.util

Interface DocSourcePositions

所有超级接口:
SourcePositions
public interface DocSourcePositions extends SourcePositions
提供了获取Javadoc注释中DocTree位置的方法。位置被定义为从CompilationUnit开头的简单字符偏移量，其中第一个字符的偏移量为0。
自版本:
1.8

  • Method Details

    • 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 - 要查找位置的树
      返回:
      树的结束位置