-
public interface DocTreeFactory
创建DocTree
节点的工厂。- Implementation Note:
-
该接口的实现中的方法只能接受由同一实现创建的
DocTree
节点。 - 从以下版本开始:
- 9
-
-
方法摘要
所有方法 接口方法 抽象方法 Modifier and Type 方法 描述 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
对象,以表示完整的文档注释。DocRootTree
newDocRootTree()
创建一个新的DocRootTree
对象,以表示一个{@docroot}
标签。EndElementTree
newEndElementTree(Name name)
创建一个新的EndElement
对象,以表示HTML元素的结尾。EntityTree
newEntityTree(Name name)
创建一个新的EntityTree
对象,以表示一个HTML实体。ErroneousTree
newErroneousTree(String text, Diagnostic<JavaFileObject> diag)
创建一个新的ErroneousTree
对象,来表示一些不可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元素的开始。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
- 文档注释中的块标记 - 结果
-
一个
DocCommentTree
对象
-
newDocRootTree
DocRootTree newDocRootTree()
创建一个新的DocRootTree
对象,以表示一个{@docroot}
标签。- 结果
-
一个
DocRootTree
对象
-
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
对象,以表示一些不可ErroneousTree
输入。- 参数
-
text
- 不可text
的文字 -
diag
- 与不可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; 否则为虚假 - 结果
-
一个
StartElementTree
对象
-
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
- 的位置 - 结果
- 这个对象,方便链接方便
-
-