方法详细信息

• newAttributeTree

  AttributeTree newAttributeTree​(Name name,
                                 AttributeTree.ValueKind vkind,
                                 List<? extends DocTree> value)

  创建一个新的 AttributeTree对象，以表示HTML标记中的HTML属性。

  参数

  name - 属性的名称

  vkind - 属性值的种类

  value - 属性的值（如果有）

  结果

  一个 AttributeTree对象

• newAuthorTree

  AuthorTree newAuthorTree​(List<? extends DocTree> name)

  创建一个新的 AuthorTree对象，以表示 {@author }标记。

  参数

  name - 作者的姓名

  结果

  一个 AuthorTree对象

• newCodeTree

  LiteralTree newCodeTree​(TextTree text)

  创建一个新的 CodeTree对象，以表示 {@code }标记。

  参数

  text - 标签的内容

  结果

  一个 CodeTree对象

• 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 - doc注释中的块标记

  结果

  一个 DocCommentTree对象

• newDocCommentTree

  DocCommentTree newDocCommentTree​(List<? extends DocTree> fullBody,
                                   List<? extends DocTree> tags,
                                   List<? extends DocTree> preamble,
                                   List<? extends DocTree> postamble)

  创建一个新的 DocCommentTree对象，以表示enitire doc注释。

  参数

  fullBody - doc评论的全部内容

  tags - doc注释中的块标记

  preamble - 包含body标签的html文件的元内容

  postamble - 包含结束体标记的html的元内容

  结果

  一个 DocCommentTree对象

  从以下版本开始：

  10

• newDocRootTree

  DocRootTree newDocRootTree()

  创建一个新的 DocRootTree对象，以表示 {@docroot}标记。

  结果

  一个 DocRootTree对象

• newDocTypeTree

  DocTypeTree newDocTypeTree​(String text)

  创建一个新的 DocTypeTree ，以表示 DOCTYPE HTML声明。

  参数

  text - 声明的内容

  结果

  一个 CommentTree对象

  从以下版本开始：

  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)

  创建一个新的 ExceptionTree对象，以表示 @exception标记。

  参数

  name - 例外的名称

  description - 可能抛出异常的原因的描述

  结果

  一个 ExceptionTree对象

• 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)

  创建一个新的 LinkPlainTree对象，以表示 {@linkplain }标记。

  参数

  ref - 被引用的API元素

  label - 链接的可选标签

  结果

  一个 LinkPlainTree对象

• newLiteralTree

  LiteralTree newLiteralTree​(TextTree text)

  创建一个新的 LiteralTree对象，以表示 {@literal }标记。

  参数

  text - 标签的内容

  结果

  一个 LiteralTree对象

• newParamTree

  ParamTree newParamTree​(boolean isTypeParameter,
                         IdentifierTree name,
                         List<? extends DocTree> description)

  创建一个新的 ParamTree对象，以表示 @param标记。

  参数

  isTypeParameter - 如果这是类型参数， 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对象

• 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对象

• newStartElementTree

  StartElementTree newStartElementTree​(Name name,
                                       List<? extends DocTree> attrs,
                                       boolean selfClosing)

  创建一个新的 StartElementTree对象，以表示HTML元素的开头。

  参数

  name - HTML元素的名称

  attrs - 属性

  selfClosing - 如果start元素标记为自闭， selfClosing true;否则为false。 否则是假的

  结果

  一个 StartElementTree对象

• newSummaryTree

  default SummaryTree newSummaryTree​(List<? extends DocTree> summary)

  创建一个新的 SummaryTree对象，以表示 @summary标记。

  实现要求：

  此实现抛出 UnsupportedOperationException 。

  参数

  summary - 标签的内容

  结果

  一个 SummaryTree对象

  从以下版本开始：

  10

• 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对象

• 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)

  获取内容列表中包含的第一个句子。 第一句的确定是特定于实现的，并且可能涉及使用特定于语言环境的BreakIterator和其他启发式方法。 结果列表可以与输入列表共享一组共同的初始项。

  参数

  list - 该列表

  结果

  a list containing the first sentence of the list.