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

接口 DocTreeFactory

public interface DocTreeFactory
用于创建 DocTree 个节点的工厂。
实现注意事项：
此接口的实现中的方法只能接受由同一实现创建的 DocTree 个节点。
自从：
9

  • 方法详情

    • newAttributeTree

      AttributeTree  newAttributeTree(Name  name, AttributeTree.ValueKind  vkind, List <? extends DocTree > value)
      创建一个新的 AttributeTree 对象，以表示 HTML 元素或标记中的属性。
      参数：
      name - 属性的名称
      vkind - 属性值的种类
      value - 属性的值（如果有）
      返回：
      一个 AttributeTree 对象

    • newAuthorTree

      AuthorTree  newAuthorTree(List <? extends DocTree > name)
      创建一个新的 AuthorTree 对象，代表一个 @author 标签。
      参数：
      name - 作者姓名
      返回：
      一个 AuthorTree 对象

    • newCodeTree

      LiteralTree  newCodeTree(TextTree  text)
      创建一个新的 LiteralTree 对象，代表一个 {@code } 标签。
      参数：
      text - 标签的内容
      返回：
      一个LiteralTree对象

    • newCommentTree

      CommentTree  newCommentTree(String  text)
      创建一个新的 CommentTree 来表示 HTML 注释。
      参数：
      text——评论内容
      返回：
      一个CommentTree对象

    • newDeprecatedTree

      DeprecatedTree  newDeprecatedTree(List <? extends DocTree > text)
      创建一个新的 DeprecatedTree 对象，代表一个 @deprecated 标签。
      参数：
      text - 标签的内容
      返回：
      一个DeprecatedTree对象

    • newDocCommentTree

      DocCommentTree  newDocCommentTree(List <? extends DocTree > fullBody, List <? extends DocTree > tags)
      创建一个新的 DocCommentTree 对象，代表一个完整的文档评论。
      参数：
      fullBody - 文档注释的整个正文
      tags - 文档注释中的块标记
      返回：
      一个DocCommentTree对象

    • newDocCommentTree

      DocCommentTree  newDocCommentTree(List <? extends DocTree > fullBody, List <? extends DocTree > tags, List <? extends DocTree > preamble, List <? extends DocTree > postamble)
      创建一个新的 DocCommentTree 对象，代表整个文档评论。
      参数：
      fullBody - 文档注释的整个正文
      tags - 文档注释中的块标记
      preamble - 包含 body 标签的 html 文件的元内容
      postamble - 包含结束正文标记的 html 的元内容
      返回：
      一个DocCommentTree对象
      自从：
      10

    • newDocRootTree

      DocRootTree  newDocRootTree()
      创建一个新的 DocRootTree 对象，代表一个 {@docRoot} 标签。
      返回：
      一个DocRootTree对象

    • newDocTypeTree

      DocTypeTree  newDocTypeTree(String  text)
      创建一个新的 DocTypeTree 来表示 DOCTYPE HTML 声明。
      参数：
      text——申报内容
      返回：
      一个DocTypeTree对象
      自从：
      10

    • newEndElementTree

      EndElementTree  newEndElementTree(Name  name)
      创建一个新的 EndElement 对象，以表示 HTML 元素的结尾。
      参数：
      name - HTML 元素的名称
      返回：
      一个 EndElementTree 对象

    • newEntityTree

      EntityTree  newEntityTree(Name  name)
      创建一个新的 EntityTree 对象，代表一个 HTML 实体。
      参数：
      name - 实体名称，代表'&'和';'之间的字符在 HTML 文档中表示实体
      返回：
      一个 EntityTree 对象

    • newErroneousTree

      ErroneousTree  newErroneousTree(String  text, Diagnostic <JavaFileObject > diag)
      创建一个新的 ErroneousTree 对象，以表示一些无法解析的输入。
      参数：
      text - 无法解析的文本
      diag - 与无法解析的文本相关联的诊断，或 null
      返回：
      一个 ErroneousTree 对象

    • newExceptionTree

      ThrowsTree  newExceptionTree(ReferenceTree  name, List <? extends DocTree > description)
      创建一个新的 ThrowsTree 对象，代表一个 @exception 标签。
      参数：
      name - 异常的名称
      description - 可能抛出异常的原因的描述
      返回：
      一个 ThrowsTree 对象

    • newHiddenTree

      HiddenTree  newHiddenTree(List <? extends DocTree > text)
      创建一个新的 HiddenTree 对象，代表一个 @hidden 标签。
      参数：
      text - 标签的内容
      返回：
      一个HiddenTree对象

    • newIdentifierTree

      IdentifierTree  newIdentifierTree(Name  name)
      创建一个新的 IdentifierTree 对象，以表示标识符，例如在 @param 标记中。
      参数：
      name - 标识符的名称
      返回：
      一个 IdentifierTree 对象

    • newIndexTree

      IndexTree  newIndexTree(DocTree  term, List <? extends DocTree > description)
      创建一个新的 IndexTree 对象，代表一个 {@index } 标签。
      参数：
      term - 搜索词
      description - 搜索词的可选描述
      返回：
      一个 IndexTree 对象

    • newInheritDocTree

      InheritDocTree  newInheritDocTree()
      创建一个新的 InheritDocTree 对象，代表一个 {@inheritDoc} 标签。
      返回：
      一个 InheritDocTree 对象

    • newLinkTree

      LinkTree  newLinkTree(ReferenceTree  ref, List <? extends DocTree > label)
      创建一个新的 LinkTree 对象，代表一个 {@link } 标签。
      参数：
      ref - 被引用的 API 元素
      label - 链接的可选标签
      返回：
      一个LinkTree对象

    • newLinkPlainTree

      LinkTree  newLinkPlainTree(ReferenceTree  ref, List <? extends DocTree > label)
      创建一个新的 LinkTree 对象，代表一个 {@linkplain } 标签。
      参数：
      ref - 被引用的 API 元素
      label - 链接的可选标签
      返回：
      一个LinkTree对象

    • newLiteralTree

      LiteralTree  newLiteralTree(TextTree  text)
      创建一个新的 LiteralTree 对象，代表一个 {@literal } 标签。
      参数：
      text - 标签的内容
      返回：
      一个LiteralTree对象

    • newParamTree

      ParamTree  newParamTree(boolean isTypeParameter, IdentifierTree  name, List <? extends DocTree > description)
      创建一个新的 ParamTree 对象，代表一个 @param 标签。
      参数：
      isTypeParameter - true 如果这是一个类型参数，false 否则
      name - 正在描述的参数
      description——参数说明
      返回：
      一个 ParamTree 对象

    • newProvidesTree

      ProvidesTree  newProvidesTree(ReferenceTree  name, List <? extends DocTree > description)
      创建一个新的 ProvidesTree 对象，代表一个 @provides 标签。
      参数：
      name - 服务类型的名称
      description - 所提供服务的描述
      返回：
      一个ProvidesTree对象

    • newReferenceTree

      ReferenceTree  newReferenceTree(String  signature)
      创建一个新的 ReferenceTree 对象，以表示对 API 元素的引用。
      参数：
      signature - 引用的文档注释签名
      返回：
      一个ReferenceTree对象

    • newReturnTree

      ReturnTree  newReturnTree(List <? extends DocTree > description)
      创建一个新的 ReturnTree 对象，代表一个 @return 标签。
      参数：
      description - 方法返回值的说明
      返回：
      一个 ReturnTree 对象

    • newReturnTree

      default ReturnTree  newReturnTree(boolean isInline, List <? extends DocTree > description)
      创建一个新的 ReturnTree 对象，以表示 @return 标签或 {@return} 标签。
      实现要求：
      如果 isInline 是 true，此实现抛出 UnsupportedOperationException，否则调用 newReturnTree(List) 。
      参数：
      isInline - true 如果此实例作为内联标记，否则为 false
      description - 方法返回值的说明
      返回：
      一个 ReturnTree 对象
      抛出：
      UnsupportedOperationException - 如果不支持内联 {@return} 标签
      自从：
      16

    • newSeeTree

      SeeTree  newSeeTree(List <? extends DocTree > reference)
      创建一个新的 SeeTree 对象，代表一个 @see 标签。
      参数：
      reference - 参考
      返回：
      一个 SeeTree 对象

    • newSerialTree

      SerialTree  newSerialTree(List <? extends DocTree > description)
      创建一个新的 SerialTree 对象，代表一个 @serial 标签。
      参数：
      description - 标签的描述
      返回：
      一个SerialTree对象

    • newSerialDataTree

      SerialDataTree  newSerialDataTree(List <? extends DocTree > description)
      创建一个新的 SerialDataTree 对象，代表一个 @serialData 标签。
      参数：
      description - 标签的描述
      返回：
      一个 SerialDataTree 对象

    • newSerialFieldTree

      SerialFieldTree  newSerialFieldTree(IdentifierTree  name, ReferenceTree  type, List <? extends DocTree > description)
      创建一个新的 SerialFieldTree 对象，代表一个 @serialField 标签。
      参数：
      name - 字段名称
      type - 字段类型
      description - 字段的描述
      返回：
      一个 SerialFieldTree 对象

    • newSinceTree

      SinceTree  newSinceTree(List <? extends DocTree > text)
      创建一个新的 SinceTree 对象，代表一个 @since 标签。
      参数：
      text - 标签的内容
      返回：
      一个 SinceTree 对象

    • newSnippetTree

      SnippetTree  newSnippetTree(List <? extends DocTree > attributes, TextTree  text)
      创建一个新的 SnippetTree 对象，代表一个 {@snippet } 标签。
      参数：
      attributes - 标签的属性
      text - 标签的主体，如果标签没有主体则为 null（不要与空主体混淆）
      返回：
      一个 SnippetTree 对象
      自从：
      18

    • newSpecTree

      SpecTree  newSpecTree(TextTree  url, List <? extends DocTree > title)
      创建一个新的 SpecTree 对象，代表一个 @spec 标签。
      参数：
      url - 网址
      title - 标题
      返回：
      一个 SpecTree 对象
      自从：
      20

    • newStartElementTree

      StartElementTree  newStartElementTree(Name  name, List <? extends DocTree > attrs, boolean selfClosing)
      创建一个新的 StartElementTree 对象，代表 HTML 元素的开始。
      参数：
      name - HTML 元素的名称
      attrs - 属性
      selfClosing - true 如果开始元素被标记为自关闭；否则false
      返回：
      一个StartElementTree对象

    • newSummaryTree

      default SummaryTree  newSummaryTree(List <? extends DocTree > summary)
      创建一个新的 SummaryTree 对象，代表一个 {@summary } 标签。
      实现要求：
      此实现抛出 UnsupportedOperationException 。
      参数：
      summary - 标签的内容
      返回：
      一个 SummaryTree 对象
      自从：
      10

    • newSystemPropertyTree

      SystemPropertyTree  newSystemPropertyTree(Name  propertyName)
      创建一个新的 SystemPropertyTree 对象，代表一个 {@systemProperty } 标签。
      参数：
      propertyName - 系统属性名称
      返回：
      一个 SystemPropertyTree 对象
      自从：
      12

    • newTextTree

      TextTree  newTextTree(String  text)
      创建一个新的 TextTree 对象，以表示一些纯文本。
      参数：
      text - 正文
      返回：
      一个 TextTree 对象

    • newThrowsTree

      ThrowsTree  newThrowsTree(ReferenceTree  name, List <? extends DocTree > description)
      创建一个新的 ThrowsTree 对象，代表一个 @throws 标签。
      参数：
      name - 异常的名称
      description - 可能抛出异常的原因的描述
      返回：
      一个 ThrowsTree 对象

    • newUnknownBlockTagTree

      UnknownBlockTagTree  newUnknownBlockTagTree(Name  name, List <? extends DocTree > content)
      创建一个新的 UnknownBlockTagTree 对象，以表示无法识别的块标记。
      参数：
      name - 方块标签的名称
      content - 内容
      返回：
      一个 UnknownBlockTagTree 对象

    • newUnknownInlineTagTree

      UnknownInlineTagTree  newUnknownInlineTagTree(Name  name, List <? extends DocTree > content)
      创建一个新的 UnknownInlineTagTree 对象，以表示无法识别的内联标签。
      参数：
      name - 内联标签的名称
      content - 内容
      返回：
      一个 UnknownInlineTagTree 对象

    • newUsesTree

      UsesTree  newUsesTree(ReferenceTree  name, List <? extends DocTree > description)
      创建一个新的 UsesTree 对象，代表一个 @uses 标签。
      参数：
      name - 服务类型的名称
      description - 服务使用方式的描述
      返回：
      一个 UsesTree 对象

    • newValueTree

      ValueTree  newValueTree(ReferenceTree  ref)
      创建一个新的 ValueTree 对象，代表一个 {@value } 标签。
      参数：
      ref - 对值的引用
      返回：
      一个 ValueTree 对象

    • newValueTree

      default ValueTree  newValueTree(TextTree  format, ReferenceTree  ref)
      创建一个新的 ValueTree 对象，代表一个 {@value } 标签。
      实现要求：
      此实现调用 newValueTree(ref) 。
      参数：
      format - 值的格式字符串
      ref - 对值的引用
      返回：
      一个 ValueTree 对象
      自从：
      20

    • newVersionTree

      VersionTree  newVersionTree(List <? extends DocTree > text)
      创建一个新的 VersionTree 对象，代表一个 {@version } 标签。
      参数：
      text - 标签的内容
      返回：
      一个 VersionTree 对象

    • at

      DocTreeFactory  at(int pos)
      设置要记录在该工厂创建的后续树节点中的位置。该位置应该是相对于源文件或 NOPOS 开头的字符偏移量。
      参数：
      pos - 位置
      返回：
      这个对象，以促进方法链接

    • getFirstSentence

      List <DocTree > getFirstSentence(List <? extends DocTree > list)
      获取内容列表中包含的第一句话。第一句话的确定是特定于实现的，并且可能涉及使用特定于locale的 BreakIterator 和其他试探法。结果列表可能与输入列表共享一组公共初始项。
      参数：
      list - 列表
      返回：
      包含列表第一句的列表