模块 jdk.compiler
包 com.sun.source.util

类 DocTrees

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

  • 构造方法详细信息

    • DocTrees

      public DocTrees()
      子类调用的构造方法。

  • 方法详情

    • 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 - 如果环境不支持 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 文件，在这种情况下，文档注释树表示 <body> 标记的内容，并且忽略任何封闭标记。如果未找到文档注释，则返回 null。未来的版本可能会支持其他文件类型。
      实现注意事项：
      此方法的默认实现为每次调用返回一个新的 DocCommentTree 实例。
      参数：
      e - 其路径用作参考的元素
      relativePath - 元素的相对路径
      返回：
      文档评论树
      抛出：
      IOException - 如果发生异常
      自从：
      9

    • getDocTreePath

      public abstract DocTreePath  getDocTreePath(FileObject  fileObject, PackageElement  packageElement)
      返回包含给定文件的文档注释树的文档树路径。该文件必须是一个 HTML 文件，在这种情况下，文档注释树表示 <body> 标签的内容，任何封闭的标签都将被忽略。文档注释树中 @see 和 {@link} 标签中对源代码元素的任何引用都将在给定包元素的上下文中进行评估。如果未找到文档注释，则返回 null。
      参数：
      fileObject - 封装 HTML 内容的文件对象
      packageElement - 与表示遗留 package.html 的给定文件对象相关联的包元素，否则为 null
      返回：
      包含从给定文件解析的文档注释的文档树路径
      抛出：
      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(path).asType() 相同的值，getElement(DocTreePath) 参数返回非空值，但可能返回包含附加信息的类型，例如参数化泛型类型而不是原始类型。
      参数：
      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 - 包含实体的树
      返回：
      包含字符的字符串