-
public interface DocTreeFactory
工厂用于创建DocTree
节点。- Implementation Note:
-
此接口的实现中的方法可能只接受由同一实现创建的
DocTree
节点。 - 从以下版本开始:
- 9
-
-
方法摘要
所有方法 实例方法 抽象方法 Default Methods 变量和类型 方法 描述 DocTreeFactory
at(int pos)
设置要在此工厂创建的后续树节点中记录的位置。List<DocTree>
getFirstSentence(List<? extends DocTree> list)
获取内容列表中包含的第一个句子。AttributeTree
newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value)
创建一个新的AttributeTree
对象,以表示HTML标记中的HTML属性。AuthorTree
newAuthorTree(List<? extends DocTree> name)
创建一个新的AuthorTree
对象,以表示{@author }
标记。LiteralTree
newCodeTree(TextTree text)
创建一个新的CodeTree
对象,以表示{@code }
标记。CommentTree
newCommentTree(String text)
创建一个新的CommentTree
,以表示HTML注释。DeprecatedTree
newDeprecatedTree(List<? extends DocTree> text)
创建一个新的DeprecatedTree
对象,以表示{@deprecated }
标记。DocCommentTree
newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags)
创建一个新的DocCommentTree
对象,以表示完整的文档注释。DocCommentTree
newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble)
创建一个新的DocCommentTree
对象,以表示enitire doc注释。DocRootTree
newDocRootTree()
创建一个新的DocRootTree
对象,以表示{@docroot}
标记。DocTypeTree
newDocTypeTree(String text)
创建一个新的DocTypeTree
,以表示DOCTYPE
HTML声明。EndElementTree
newEndElementTree(Name name)
创建一个新的EndElement
对象,以表示HTML元素的结尾。EntityTree
newEntityTree(Name name)
创建一个新的EntityTree
对象,以表示HTML实体。ErroneousTree
newErroneousTree(String text, Diagnostic<JavaFileObject> diag)
创建一个新的ErroneousTree
对象,以表示一些不可解析的输入。ThrowsTree
newExceptionTree(ReferenceTree name, List<? extends DocTree> description)
创建一个新的ExceptionTree
对象,以表示@exception
标记。HiddenTree
newHiddenTree(List<? extends DocTree> text)
创建一个新的HiddenTree
对象,以表示{@hidden }
标记。IdentifierTree
newIdentifierTree(Name name)
创建一个新的IdentifierTree
对象,以表示标识符,例如在@param
标记中。IndexTree
newIndexTree(DocTree term, List<? extends DocTree> description)
创建一个新的IndexTree
对象,以表示{@index }
标记。InheritDocTree
newInheritDocTree()
创建一个新的InheritDocTree
对象,以表示{@inheritDoc}
标记。LinkTree
newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label)
创建一个新的LinkPlainTree
对象,以表示{@linkplain }
标记。LinkTree
newLinkTree(ReferenceTree ref, List<? extends DocTree> label)
创建一个新的LinkTree
对象,以表示{@link }
标记。LiteralTree
newLiteralTree(TextTree text)
创建一个新的LiteralTree
对象,以表示{@literal }
标记。ParamTree
newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description)
创建一个新的ParamTree
对象,以表示@param
标记。ProvidesTree
newProvidesTree(ReferenceTree name, List<? extends DocTree> description)
创建一个新的ProvidesTree
对象,以表示@provides
标记。ReferenceTree
newReferenceTree(String signature)
创建一个新的ReferenceTree
对象,以表示对API元素的引用。ReturnTree
newReturnTree(List<? extends DocTree> description)
创建一个新的ReturnTree
对象,以表示@return
标记。SeeTree
newSeeTree(List<? extends DocTree> reference)
创建一个新的SeeTree
对象,以表示@see
标记。SerialDataTree
newSerialDataTree(List<? extends DocTree> description)
创建一个新的SerialDataTree
对象,以表示@serialData
标记。SerialFieldTree
newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description)
创建一个新的SerialFieldTree
对象,以表示@serialField
标记。SerialTree
newSerialTree(List<? extends DocTree> description)
创建一个新的SerialTree
对象,以表示@serial
标记。SinceTree
newSinceTree(List<? extends DocTree> text)
创建一个新的SinceTree
对象,以表示@since
标记。StartElementTree
newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing)
创建一个新的StartElementTree
对象,以表示HTML元素的开头。default SummaryTree
newSummaryTree(List<? extends DocTree> summary)
创建一个新的SummaryTree
对象,以表示@summary
标记。TextTree
newTextTree(String text)
创建一个新的TextTree
对象,以表示一些纯文本。ThrowsTree
newThrowsTree(ReferenceTree name, List<? extends DocTree> description)
创建一个新的ThrowsTree
对象,以表示@throws
标记。UnknownBlockTagTree
newUnknownBlockTagTree(Name name, List<? extends DocTree> content)
创建一个新的UnknownBlockTagTree
对象,以表示无法识别的块标记。UnknownInlineTagTree
newUnknownInlineTagTree(Name name, List<? extends DocTree> content)
创建一个新的UnknownInlineTagTree
对象,以表示无法识别的内联标记。UsesTree
newUsesTree(ReferenceTree name, List<? extends DocTree> description)
创建一个新的UsesTree
对象,以表示@uses
标记。ValueTree
newValueTree(ReferenceTree ref)
创建一个新的ValueTree
对象,以表示{@value }
标记。VersionTree
newVersionTree(List<? extends DocTree> text)
创建一个新的VersionTree
对象,以表示{@version }
标记。
-
-
-
方法详细信息
-
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
- 职位 - 结果
- 这个对象,方便链接方法
-
-