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

Class DocTrees

java.lang.Object
com.sun.source.util.Trees
com.sun.source.util.DocTrees
public abstract class DocTrees extends Trees
提供对文档注释语法树的访问。
自版本:
1.8

  • Constructor Details

    • DocTrees

      public DocTrees()
      供子类调用的构造函数。

  • Method Details

    • instance

      public static DocTrees instance(JavaCompiler.CompilationTask task)
      返回给定CompilationTask的DocTrees对象。
      参数:
      task - 要获取Trees对象的编译任务
      返回:
      DocTrees对象
      抛出:
      IllegalArgumentException - 如果任务不支持Trees API。

    • instance

      public static DocTrees instance(ProcessingEnvironment env)
      返回给定ProcessingEnvironment的DocTrees对象。
      参数:
      env - 要获取Trees对象的处理环境
      返回:
      DocTrees对象
      抛出:
      IllegalArgumentException - 如果env不支持Trees API。

    • getBreakIterator

      public abstract BreakIterator getBreakIterator()
      返回用于计算文档注释第一句的断句迭代器。如果未指定，则返回null。
      返回:
      断句迭代器
      自版本:
      9

    • getDocCommentTree

      public abstract DocCommentTree getDocCommentTree(TreePath path)
      返回由给定TreePath标识的Tree节点的文档注释树（如果有的话）。如果未找到文档注释，则返回null。
      实现说明:
      此方法的默认实现对于重复使用相同参数的调用返回相同的DocCommentTree实例。
      参数:
      path - 树节点的路径
      返回:
      文档注释树

    • getDocCommentTree

      public abstract DocCommentTree getDocCommentTree(Element e)
      返回给定元素的文档注释树。如果未找到文档注释，则返回null。
      实现说明:
      此方法的默认实现对于重复使用相同参数的调用返回相同的DocCommentTree实例。
      参数:
      e - 需要文档的元素
      返回:
      文档注释树
      自版本:
      9

    • getDocCommentTree

      public abstract DocCommentTree getDocCommentTree(FileObject fileObject)
      返回给定文件的文档注释树。文件必须是HTML文件，在这种情况下，文档注释树表示文件的整个内容。如果未找到文档注释，则返回null。未来的版本可能支持其他文件类型。
      实现说明:
      此方法的默认实现对于每次调用都返回一个新的DocCommentTree实例。
      参数:
      fileObject - 内容容器
      返回:
      文档注释树
      自版本:
      9

    • getDocCommentTree

      public abstract DocCommentTree getDocCommentTree(Element e, String relativePath) throws IOException
      返回相对于给定元素指定的路径的给定文件的文档注释树。文件必须是HTML文件，在这种情况下，文档注释树表示标签的内容，忽略任何包围标签。如果未找到文档注释，则返回null。未来的版本可能支持其他文件类型。
      实现说明:
      此方法的默认实现对于每次调用都返回一个新的DocCommentTree实例。
      参数:
      e - 用作引用的元素
      relativePath - 从元素的相对路径
      返回:
      文档注释树
      抛出:
      IOException - 如果发生异常
      自版本:
      9

    • getDocTreePath

      public abstract DocTreePath getDocTreePath(FileObject fileObject, PackageElement packageElement)
      返回包含给定文件的文档注释树的doc树路径。文件必须是HTML文件，在这种情况下，文档注释树表示<body>标签的内容，忽略任何包围标签。在文档注释树中包含的@see和{@link}标签中的源代码元素的任何引用将在给定包元素的上下文中进行评估。如果未找到文档注释，则返回null。
      参数:
      fileObject - 封装HTML内容的文件对象
      packageElement - 与表示旧版package.html的给定文件对象关联的包元素，否则为null
      返回:
      包含从给定文件解析的文档注释的doc树路径
      抛出:
      IllegalArgumentException - 如果fileObject不是HTML文件
      自版本:
      9

    • getElement

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

    • getType

      public abstract TypeMirror getType(DocTreePath path)
      返回由给定DocTreePath的叶节点引用的语言模型类型，如果未知则返回null。对于path参数，此方法通常返回与getElement(DocTreePath)返回非null值的路径相同的值，但可能返回包含其他信息的类型，例如参数化泛型类型而不是原始类型。
      参数:
      path - 树节点的路径
      返回:
      引用的类型，或null
      自版本:
      15

    • getFirstSentence

      public abstract List<DocTree> getFirstSentence(List<? extends DocTree> list)
      返回表示注释第一句的DocTree列表。
      参数:
      list - 要查询的DocTree列表
      返回:
      第一句
      自版本:
      9

    • getSourcePositions

      public abstract DocSourcePositions getSourcePositions()
      返回用于访问文档树节点的源位置的实用对象。
      指定者:
      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)
      设置用于计算文档注释第一句的断句迭代器。
      参数:
      breakIterator - 一个断句迭代器，或null以指定默认的句子分隔符
      自版本:
      9

    • getDocTreeFactory

      public abstract DocTreeFactory getDocTreeFactory()
      返回用于创建DocTree对象的实用对象。
      返回:
      用于创建DocTree对象的实用对象
      自版本:
      9

    • getCharacters

      public abstract String getCharacters(EntityTree tree)
      返回包含给定实体树中实体字符的字符串，如果树不表示有效的字符序列，则返回null。

      实体的解释基于HTML 5.2规范中的第8.1.4节字符引用。

      参数:
      tree - 包含实体的树
      返回:
      包含字符的字符串
      外部规范