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

Class DocTrees


  • public abstract class DocTrees
extends Trees
    提供对文档注释的语法树的访问。
    从以下版本开始：
    1.8

    • 构造方法详细信息

      • DocTrees

        public DocTrees​()

    • 方法详细信息

      • instance

        public static DocTrees instance​(ProcessingEnvironment env)
        返回给定的ProcessingEnvironment的DocTrees对象。
        参数
        env - 为其获取Trees对象的处理环境
        结果
        DocTrees对象
        异常
        IllegalArgumentException - 如果env不支持Trees API。

      • getBreakIterator

        public abstract BreakIterator getBreakIterator​()
        返回用于计算文档注释第一句的break迭代器。 如果没有指定，则返回null 。
        结果
        中断迭代器
        从以下版本开始：
        9

      • getDocCommentTree

        public abstract DocCommentTree getDocCommentTree​(TreePath path)
        返回由给定TreePath标识的Tree节点的doc注释树（如果有）。 如果没有找到文档评论，则返回null 。
        参数
        path - 树节点的路径
        结果
        文档注释树

      • getDocCommentTree

        public abstract DocCommentTree getDocCommentTree​(Element e)
        返回给定元素的文档注释树。 如果没有找到文档评论，则返回null 。
        参数
        e - 需要文档的元素
        结果
        文档注释树
        从以下版本开始：
        9

      • getDocCommentTree

        public abstract DocCommentTree getDocCommentTree​(FileObject fileObject)
        返回给定文件的文档注释树。 文件必须是HTML文件，在这种情况下，文档注释树表示<body>标签的内容，任何封闭标签都将被忽略。 如果没有找到文档评论，则返回null 。 未来版本可能支持其他文件类型。
        参数
        fileObject - 内容容器
        结果
        文档注释树
        从以下版本开始：
        9

      • getDocCommentTree

        public abstract DocCommentTree getDocCommentTree​(Element e,
                                                 String relativePath)
                                          throws IOException
        返回相对于给定元素指定路径的给定文件的doc注释树。 文件必须是HTML文件，在这种情况下，文档注释树表示<body>标签的内容，任何封闭标签都将被忽略。 如果没有找到文档评论，则返回null 。 未来版本可能支持其他文件类型。
        参数
        e - 其路径用作参考的元素
        relativePath - 从元素的相对路径
        结果
        文档注释树
        异常
        IOException - 如果发生异常
        从以下版本开始：
        9

      • getDocTreePath

        public abstract DocTreePath getDocTreePath​(FileObject fileObject,
                                           PackageElement packageElement)
        返回包含给定文件的文档注释树的文档树路径。 该文件必须是HTML文件，在这种情况下，文档注释树表示<body>标记的内容，任何封闭标签都将被忽略。 任何对doc注释树中@see和{@link}标签中包含的源代码元素的引用将在给定的包元素的上下文中进行评估。 如果没有找到文档评论，则返回null 。
        参数
        fileObject - 封装HTML内容的文件对象
        packageElement - 与表示遗留package.html的给定文件对象关联的包元素，否则为空
        结果
        包含从给定文件解析的文档注释的文档树路径
        异常
        IllegalArgumentException - 如果fileObject不是HTML文件
        从以下版本开始：
        9

      • getElement

        public abstract Element getElement​(DocTreePath path)
        返回给定的DocTreePath的叶节点引用的语言模型元素，如果未知的话null 。
        参数
        path - 树节点的路径
        结果
        元素

      • getFirstSentence

        public abstract List<DocTree> getFirstSentence​(List<? extends DocTree> list)
        返回表示评论第一句的DocTree的列表。
        参数
        list - 要查询的DocTree列表
        结果
        第一句话
        从以下版本开始：
        9

      • getSourcePositions

        public abstract DocSourcePositions getSourcePositions​()
        返回用于访问文档树节点的源位置的实用程序对象。
        Specified by:
        getSourcePositions在 Trees
        结果
        实用程序对象

      • printMessage

        public abstract void printMessage​(Diagnostic.Kind kind,
                                  CharSequence msg,
                                  DocTree t,
                                  DocCommentTree c,
                                  CompilationUnitTree root)
        在提供的编译单元中的树的位置打印指定类型的消息
        参数
        kind - 消息的种类
        msg - 消息，或空字符串（如果没有）
        t - 树用作位置提示
        c - 用作位置提示的文档注释树
        root - 包含树的编译单元

      • setBreakIterator

        public abstract void setBreakIterator​(BreakIterator breakiterator)
        设置break迭代器来计算文档注释的第一个句子。
        参数
        breakiterator - 一个中断迭代器或者 null来指定默认的断句
        从以下版本开始：
        9

      • getDocTreeFactory

        public abstract DocTreeFactory getDocTreeFactory​()
        返回一个用于创建 DocTree对象的实用程序对象。
        结果
        一个用于创建 DocTree对象的实用程序对象
        从以下版本开始：
        9