public interface DocTreeFactory
DocTree
nodes.DocTree
nodes that have been created by the same implementation.Modifier and Type | Method | Description |
---|---|---|
DocTreeFactory |
at(int pos) |
Set the position to be recorded in subsequent tree nodes created by this factory.
|
List<DocTree> |
getFirstSentence(List<? extends DocTree> list) |
Get the first sentence contained in a list of content.
|
AttributeTree |
newAttributeTree(Name name,
AttributeTree.ValueKind vkind,
List<? extends DocTree> value) |
Create a new
AttributeTree object, to represent an HTML attribute in an HTML tag. |
AuthorTree |
newAuthorTree(List<? extends DocTree> name) |
Create a new
AuthorTree object, to represent an {@author } tag. |
LiteralTree |
newCodeTree(TextTree text) |
Create a new
CodeTree object, to represent a {@code } tag. |
CommentTree |
newCommentTree(String text) |
Create a new
CommentTree , to represent an HTML comment. |
DeprecatedTree |
newDeprecatedTree(List<? extends DocTree> text) |
Create a new
DeprecatedTree object, to represent an {@deprecated } tag. |
DocCommentTree |
newDocCommentTree(List<? extends DocTree> fullBody,
List<? extends DocTree> tags) |
Create a new
DocCommentTree object, to represent a complete doc comment. |
DocRootTree |
newDocRootTree() |
Create a new
DocRootTree object, to represent an {@docroot} tag. |
EndElementTree |
newEndElementTree(Name name) |
Create a new
EndElement object, to represent the end of an HTML element. |
EntityTree |
newEntityTree(Name name) |
Create a new
EntityTree object, to represent an HTML entity. |
ErroneousTree |
newErroneousTree(String text,
Diagnostic<JavaFileObject> diag) |
Create a new
ErroneousTree object, to represent some unparseable input. |
ThrowsTree |
newExceptionTree(ReferenceTree name,
List<? extends DocTree> description) |
Create a new
ExceptionTree object, to represent an @exception tag. |
HiddenTree |
newHiddenTree(List<? extends DocTree> text) |
Create a new
HiddenTree object, to represent an {@hidden } tag. |
IdentifierTree |
newIdentifierTree(Name name) |
Create a new
IdentifierTree object, to represent an identifier, such as in a
@param tag. |
IndexTree |
newIndexTree(DocTree term,
List<? extends DocTree> description) |
Create a new
IndexTree object, to represent an {@index } tag. |
InheritDocTree |
newInheritDocTree() |
Create a new
InheritDocTree object, to represent an {@inheritDoc} tag. |
LinkTree |
newLinkPlainTree(ReferenceTree ref,
List<? extends DocTree> label) |
Create a new
LinkPlainTree object, to represent a {@linkplain } tag. |
LinkTree |
newLinkTree(ReferenceTree ref,
List<? extends DocTree> label) |
Create a new
LinkTree object, to represent a {@link } tag. |
LiteralTree |
newLiteralTree(TextTree text) |
Create a new
LiteralTree object, to represent a {@literal } tag. |
ParamTree |
newParamTree(boolean isTypeParameter,
IdentifierTree name,
List<? extends DocTree> description) |
Create a new
ParamTree object, to represent a @param tag. |
ProvidesTree |
newProvidesTree(ReferenceTree name,
List<? extends DocTree> description) |
Create a new
ProvidesTree object, to represent a @provides tag. |
ReferenceTree |
newReferenceTree(String signature) |
Create a new
ReferenceTree object, to represent a reference to an API element. |
ReturnTree |
newReturnTree(List<? extends DocTree> description) |
Create a new
ReturnTree object, to represent a @return tag. |
SeeTree |
newSeeTree(List<? extends DocTree> reference) |
Create a new
SeeTree object, to represent a @see tag. |
SerialDataTree |
newSerialDataTree(List<? extends DocTree> description) |
Create a new
SerialDataTree object, to represent a @serialData tag. |
SerialFieldTree |
newSerialFieldTree(IdentifierTree name,
ReferenceTree type,
List<? extends DocTree> description) |
Create a new
SerialFieldTree object, to represent a @serialField tag. |
SerialTree |
newSerialTree(List<? extends DocTree> description) |
Create a new
SerialTree object, to represent a @serial tag. |
SinceTree |
newSinceTree(List<? extends DocTree> text) |
Create a new
SinceTree object, to represent a @since tag. |
StartElementTree |
newStartElementTree(Name name,
List<? extends DocTree> attrs,
boolean selfClosing) |
Create a new
StartElementTree object, to represent the start of an HTML element. |
TextTree |
newTextTree(String text) |
Create a new
TextTree object, to represent some plain text. |
ThrowsTree |
newThrowsTree(ReferenceTree name,
List<? extends DocTree> description) |
Create a new
ThrowsTree object, to represent a @throws tag. |
UnknownBlockTagTree |
newUnknownBlockTagTree(Name name,
List<? extends DocTree> content) |
Create a new
UnknownBlockTagTree object, to represent an unrecognized block tag. |
UnknownInlineTagTree |
newUnknownInlineTagTree(Name name,
List<? extends DocTree> content) |
Create a new
UnknownInlineTagTree object, to represent an unrecognized inline tag. |
UsesTree |
newUsesTree(ReferenceTree name,
List<? extends DocTree> description) |
Create a new
UsesTree object, to represent a @uses tag. |
ValueTree |
newValueTree(ReferenceTree ref) |
Create a new
ValueTree object, to represent a {@value } tag. |
VersionTree |
newVersionTree(List<? extends DocTree> text) |
Create a new
VersionTree object, to represent a {@version } tag. |
AttributeTree newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value)
AttributeTree
object, to represent an HTML attribute in an HTML tag.name
- the name of the attributevkind
- the kind of attribute valuevalue
- the value, if any, of the attributeAttributeTree
objectAuthorTree newAuthorTree(List<? extends DocTree> name)
AuthorTree
object, to represent an {@author }
tag.name
- the name of the authorAuthorTree
objectLiteralTree newCodeTree(TextTree text)
CodeTree
object, to represent a {@code }
tag.text
- the content of the tagCodeTree
objectCommentTree newCommentTree(String text)
CommentTree
, to represent an HTML comment.text
- the content of the commentCommentTree
objectDeprecatedTree newDeprecatedTree(List<? extends DocTree> text)
DeprecatedTree
object, to represent an {@deprecated }
tag.text
- the content of the tagDeprecatedTree
objectDocCommentTree newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags)
DocCommentTree
object, to represent a complete doc comment.fullBody
- the entire body of the doc commenttags
- the block tags in the doc commentDocCommentTree
objectDocRootTree newDocRootTree()
DocRootTree
object, to represent an {@docroot}
tag.DocRootTree
objectEndElementTree newEndElementTree(Name name)
EndElement
object, to represent the end of an HTML element.name
- the name of the HTML elementEndElementTree
objectEntityTree newEntityTree(Name name)
EntityTree
object, to represent an HTML entity.name
- the name of the entity, representing the characters between '<' and ';'
in the representation of the entity in an HTML documentEntityTree
objectErroneousTree newErroneousTree(String text, Diagnostic<JavaFileObject> diag)
ErroneousTree
object, to represent some unparseable input.text
- the unparseable textdiag
- a diagnostic associated with the unparseable text, or nullErroneousTree
objectThrowsTree newExceptionTree(ReferenceTree name, List<? extends DocTree> description)
ExceptionTree
object, to represent an @exception
tag.name
- the name of the exceptiondescription
- a description of why the exception might be thrownExceptionTree
objectHiddenTree newHiddenTree(List<? extends DocTree> text)
HiddenTree
object, to represent an {@hidden }
tag.text
- the content of the tagHiddenTree
objectIdentifierTree newIdentifierTree(Name name)
IdentifierTree
object, to represent an identifier, such as in a
@param
tag.name
- the name of the identifierIdentifierTree
objectIndexTree newIndexTree(DocTree term, List<? extends DocTree> description)
IndexTree
object, to represent an {@index }
tag.term
- the search termdescription
- an optional description of the search termIndexTree
objectInheritDocTree newInheritDocTree()
InheritDocTree
object, to represent an {@inheritDoc}
tag.InheritDocTree
objectLinkTree newLinkTree(ReferenceTree ref, List<? extends DocTree> label)
LinkTree
object, to represent a {@link }
tag.ref
- the API element being referencedlabel
- an optional label for the linkLinkTree
objectLinkTree newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label)
LinkPlainTree
object, to represent a {@linkplain }
tag.ref
- the API element being referencedlabel
- an optional label for the linkLinkPlainTree
objectLiteralTree newLiteralTree(TextTree text)
LiteralTree
object, to represent a {@literal }
tag.text
- the content of the tagLiteralTree
objectParamTree newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description)
ParamTree
object, to represent a @param
tag.isTypeParameter
- true if this is a type parameter, and false otherwisename
- the parameter being describeddescription
- the description of the parameterParamTree
objectProvidesTree newProvidesTree(ReferenceTree name, List<? extends DocTree> description)
ProvidesTree
object, to represent a @provides
tag.name
- the name of the service typedescription
- a description of the service being providedProvidesTree
objectReferenceTree newReferenceTree(String signature)
ReferenceTree
object, to represent a reference to an API element.signature
- the doc comment signature of the referenceReferenceTree
objectReturnTree newReturnTree(List<? extends DocTree> description)
ReturnTree
object, to represent a @return
tag.description
- the description of the return value of a methodReturnTree
objectSeeTree newSeeTree(List<? extends DocTree> reference)
SeeTree
object, to represent a @see
tag.reference
- the referenceSeeTree
objectSerialTree newSerialTree(List<? extends DocTree> description)
SerialTree
object, to represent a @serial
tag.description
- the description for the tagSerialTree
objectSerialDataTree newSerialDataTree(List<? extends DocTree> description)
SerialDataTree
object, to represent a @serialData
tag.description
- the description for the tagSerialDataTree
objectSerialFieldTree newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description)
SerialFieldTree
object, to represent a @serialField
tag.name
- the name of the fieldtype
- the type of the fielddescription
- the description of the fieldSerialFieldTree
objectSinceTree newSinceTree(List<? extends DocTree> text)
SinceTree
object, to represent a @since
tag.text
- the content of the tagSinceTree
objectStartElementTree newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing)
StartElementTree
object, to represent the start of an HTML element.name
- the name of the HTML elementattrs
- the attributesselfClosing
- true if the start element is marked as self-closing; otherwise falseStartElementTree
objectTextTree newTextTree(String text)
TextTree
object, to represent some plain text.text
- the textTextTree
objectThrowsTree newThrowsTree(ReferenceTree name, List<? extends DocTree> description)
ThrowsTree
object, to represent a @throws
tag.name
- the name of the exceptiondescription
- a description of why the exception might be thrownThrowsTree
objectUnknownBlockTagTree newUnknownBlockTagTree(Name name, List<? extends DocTree> content)
UnknownBlockTagTree
object, to represent an unrecognized block tag.name
- the name of the block tagcontent
- the contentUnknownBlockTagTree
objectUnknownInlineTagTree newUnknownInlineTagTree(Name name, List<? extends DocTree> content)
UnknownInlineTagTree
object, to represent an unrecognized inline tag.name
- the name of the inline tagcontent
- the contentUnknownInlineTagTree
objectUsesTree newUsesTree(ReferenceTree name, List<? extends DocTree> description)
UsesTree
object, to represent a @uses
tag.name
- the name of the service typedescription
- a description of how the service will be usedUsesTree
objectValueTree newValueTree(ReferenceTree ref)
ValueTree
object, to represent a {@value }
tag.ref
- a reference to the valueValueTree
objectVersionTree newVersionTree(List<? extends DocTree> text)
VersionTree
object, to represent a {@version }
tag.text
- the content of the tagVersionTree
objectDocTreeFactory at(int pos)
NOPOS
.pos
- the positionList<DocTree> getFirstSentence(List<? extends DocTree> list)
BreakIterator
and other heuristics.
The resulting list may share a common set of initial items with the input list.list
- the list Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 2005, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-Ubuntu+0-9b161-1