Module  jdk.compiler
软件包  com.sun.source.util

Interface DocSourcePositions

  • All Superinterfaces:
    SourcePositions 

    public interface DocSourcePositions
extends SourcePositions
    提供在javadoc注释中获取DocTree的位置的方法。 一个位置被定义为从CompilationUnit开始的简单字符偏移量，其中第一个字符处于偏移量0。
    从以下版本开始：
    1.8

    • 方法详细信息

      • 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 - 寻找职位的树。
        结果
        树的起始位置。