DocTree nodes.
Implementation Note
The methods in an implementation of this interface may only accept DocTree
nodes that have been created by the same implementation.
| Modifier and Type | Method and Description |
|---|---|
| public DocTreeFactory | Returns: this object, to facilitate method chainingthe position pos)Sets the position to be recorded in subsequent tree nodes created by this factory. |
| public List | Returns: a list containing the first sentence of the listthe list list)Gets the first sentence contained in a list of content. |
| public AttributeTree | Returns: anAttributeTree objectthe name of the attribute name, AttributeTree.the kind of the attribute value vkind,the value, if any, of the attribute value)Creates a new |
| public AuthorTree | Returns: anAuthorTree objectthe name of the author name)Creates a new |
| public LiteralTree | Returns: aLiteralTree objectthe content of the tag text)Creates a new |
| public CommentTree | Returns: aCommentTree objectthe content of the comment text)Creates a new |
| public DeprecatedTree | Returns: aDeprecatedTree objectthe content of the tag text)Creates a new |
| public DocCommentTree | Returns: aDocCommentTree objectthe entire body of the doc comment fullBody, List<? extends DocTree> the block tags in the doc comment tags)Creates a new |
| public DocCommentTree | Returns: aDocCommentTree objectthe entire body of the doc comment fullBody, List<? extends DocTree> the block tags in the doc comment tags, List<? extends DocTree> the meta content of an html file including the body tag preamble, List<? extends DocTree> the meta content of an html including the closing body tag postamble)Creates a new |
| public DocRootTree | Returns: aDocRootTree objectCreates a new |
| public DocTypeTree | Returns: aDocTypeTree objectthe content of the declaration text)Creates a new |
| public EndElementTree | Returns: anEndElementTree objectthe name of the HTML element name)Creates a new |
| public EntityTree | Returns: anEntityTree objectthe name of the entity, representing the characters between '&' and ';'
in the representation of the entity in an HTML document name)Creates a new |
| public ErroneousTree | Returns: anErroneousTree objectthe unparseable text text, Diagnostic<JavaFileObject> a diagnostic associated with the unparseable text, or diag)nullCreates a new |
| public EscapeTree | Returns: anEscapeTree objectthe character ch)Creates a new |
| public ThrowsTree | Returns: anThrowsTree objectthe name of the exception name, List<? extends DocTree> a description of why the exception might be thrown description)Creates a new |
| public HiddenTree | Returns: aHiddenTree objectthe content of the tag text)Creates a new |
| public IdentifierTree | Returns: anIdentifierTree objectthe name of the identifier name)Creates a new |
| public IndexTree | Returns: anIndexTree objectthe search term term, List<? extends DocTree> an optional description of the search term description)Creates a new |
| public InheritDocTree | Returns: anInheritDocTree objectCreates a new |
| public default InheritDocTree | Returns: anInheritDocTree objecta superclass or superinterface reference supertype)Creates a new |
| public LinkTree | Returns: aLinkTree objectthe API element being referenced ref, List<? extends DocTree> an optional label for the link label)Creates a new |
| public LinkTree | Returns: aLinkTree objectthe API element being referenced ref, List<? extends DocTree> an optional label for the link label)Creates a new |
| public LiteralTree | Returns: aLiteralTree objectthe content of the tag text)Creates a new |
| public ParamTree | Returns: aParamTree objecttrue if this is a type parameter, and false otherwisethe parameter being described name, List<? extends DocTree> the description of the parameter description)Creates a new |
| public ProvidesTree | Returns: aProvidesTree objectthe name of the service type name, List<? extends DocTree> a description of the service being provided description)Creates a new |
| public RawTextTree | Returns: aRawTextTree objectthe kind of text kind,the code code)Creates a new |
| public ReferenceTree | Returns: aReferenceTree objectthe doc comment signature of the reference signature)Creates a new |
| public ReturnTree | Returns: aReturnTree objectthe description of the return value of a method description)Creates a new |
| public default ReturnTree | Returns: aReturnTree objecttrue if this instance is as an inline tag,
and false otherwisethe description of the return value of a method description)Creates a new |
| public SeeTree | Returns: aSeeTree objectthe reference reference)Creates a new |
| public SerialDataTree | Returns: aSerialDataTree objectthe description for the tag description)Creates a new |
| public SerialFieldTree | Returns: aSerialFieldTree objectthe name of the field name, ReferenceTree the type of the field type, List<? extends DocTree> the description of the field description)Creates a new |
| public SerialTree | Returns: aSerialTree objectthe description for the tag description)Creates a new |
| public SinceTree | Returns: aSinceTree objectthe content of the tag text)Creates a new |
| public SnippetTree | Returns: aSnippetTree objectthe attributes of the tag attributes, TextTree the body of the tag, or text)null if the tag has no body (not to be confused with an empty body)Creates a new |
| public SpecTree | Returns: aSpecTree objectthe url url, List<? extends DocTree> the title title)Creates a new |
| public StartElementTree | Returns: aStartElementTree objectthe name of the HTML element name, List<? extends DocTree> the attributes attrs, boolean true if the start element is marked as self-closing; otherwise falseCreates a new |
| public default SummaryTree | Returns: aSummaryTree objectthe content of the tag summary)Creates a new |
| public SystemPropertyTree | Returns: aSystemPropertyTree objectthe system property name propertyName)Creates a new |
| public TextTree | Returns: aTextTree objectthe text text)Creates a new |
| public ThrowsTree | Returns: aThrowsTree objectthe name of the exception name, List<? extends DocTree> a description of why the exception might be thrown description)Creates a new |
| public UnknownBlockTagTree | Returns: anUnknownBlockTagTree objectthe name of the block tag name, List<? extends DocTree> the content content)Creates a new |
| public UnknownInlineTagTree | Returns: anUnknownInlineTagTree objectthe name of the inline tag name, List<? extends DocTree> the content content)Creates a new |
| public UsesTree | Returns: aUsesTree objectthe name of the service type name, List<? extends DocTree> a description of how the service will be used description)Creates a new |
| public ValueTree | Returns: aValueTree objecta reference to the value ref)Creates a new |
| public default ValueTree | Returns: aValueTree objecta format string for the value format, ReferenceTree a reference to the value ref)Creates a new |
| public VersionTree | Returns: aVersionTree objectthe content of the tag text)Creates a new |
| at | back to summary |
|---|---|
| public DocTreeFactory at(int pos) Sets the position to be recorded in subsequent tree nodes created by this factory.
The position should be a character offset relative to the beginning of the source file
or
| |
| getFirstSentence | back to summary |
|---|---|
| public List Gets the first sentence contained in a list of content.
The determination of the first sentence is implementation specific, and may
involve the use of a locale-specific | |
| newAttributeTree | back to summary |
|---|---|
| public AttributeTree newAttributeTree(Name name, AttributeTree. Creates a new
| |
| newAuthorTree | back to summary |
|---|---|
| public AuthorTree newAuthorTree(List<? extends DocTree> name) Creates a new
| |
| newCodeTree | back to summary |
|---|---|
| public LiteralTree newCodeTree(TextTree text) Creates a new
| |
| newCommentTree | back to summary |
|---|---|
| public CommentTree newCommentTree(String text) Creates a new
| |
| newDeprecatedTree | back to summary |
|---|---|
| public DeprecatedTree newDeprecatedTree(List<? extends DocTree> text) Creates a new
| |
| newDocCommentTree | back to summary |
|---|---|
| public DocCommentTree newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags) Creates a new
| |
| newDocCommentTree | back to summary |
|---|---|
| public DocCommentTree newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble) Creates a new
| |
| newDocRootTree | back to summary |
|---|---|
| public DocRootTree newDocRootTree() Creates a new
| |
| newDocTypeTree | back to summary |
|---|---|
| public DocTypeTree newDocTypeTree(String text) Creates a new
| |
| newEndElementTree | back to summary |
|---|---|
| public EndElementTree newEndElementTree(Name name) Creates a new
| |
| newEntityTree | back to summary |
|---|---|
| public EntityTree newEntityTree(Name name) Creates a new
| |
| newErroneousTree | back to summary |
|---|---|
| public ErroneousTree newErroneousTree(String text, Diagnostic<JavaFileObject> diag) Creates a new
| |
| newEscapeTree | back to summary |
|---|---|
| public EscapeTree newEscapeTree(char ch) Creates a new API Note This method does not itself constrain the set of valid escape sequences, although the set may be effectively constrained to those defined in the Documentation Comment Specification for the Standard Doclet, including the following context-sensitive escape sequences:
| |
| newExceptionTree | back to summary |
|---|---|
| public ThrowsTree newExceptionTree(ReferenceTree name, List<? extends DocTree> description) Creates a new
| |
| newHiddenTree | back to summary |
|---|---|
| public HiddenTree newHiddenTree(List<? extends DocTree> text) Creates a new
| |
| newIdentifierTree | back to summary |
|---|---|
| public IdentifierTree newIdentifierTree(Name name) Creates a new
| |
| newIndexTree | back to summary |
|---|---|
| public IndexTree newIndexTree(DocTree term, List<? extends DocTree> description) Creates a new | |
| newInheritDocTree | back to summary |
|---|---|
| public InheritDocTree newInheritDocTree() Creates a new
| |
| newInheritDocTree | back to summary |
|---|---|
| public default InheritDocTree newInheritDocTree(ReferenceTree supertype) Creates a new Implementation Specification This implementation throws
| |
| newLinkPlainTree | back to summary |
|---|---|
| public LinkTree newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label) Creates a new
| |
| newLinkTree | back to summary |
|---|---|
| public LinkTree newLinkTree(ReferenceTree ref, List<? extends DocTree> label) Creates a new
| |
| newLiteralTree | back to summary |
|---|---|
| public LiteralTree newLiteralTree(TextTree text) Creates a new
| |
| newParamTree | back to summary |
|---|---|
| public ParamTree newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description) Creates a new
| |
| newProvidesTree | back to summary |
|---|---|
| public ProvidesTree newProvidesTree(ReferenceTree name, List<? extends DocTree> description) Creates a new
| |
| newRawTextTree | back to summary |
|---|---|
| public RawTextTree newRawTextTree(DocTree. Creates a new
| |
| newReferenceTree | back to summary |
|---|---|
| public ReferenceTree newReferenceTree(String signature) Creates a new
| |
| newReturnTree | back to summary |
|---|---|
| public ReturnTree newReturnTree(List<? extends DocTree> description) Creates a new
| |
| newReturnTree | back to summary |
|---|---|
| public default ReturnTree newReturnTree(boolean isInline, List<? extends DocTree> description) Creates a new Implementation Specification This implementation throws
| |
| newSeeTree | back to summary |
|---|---|
| public SeeTree newSeeTree(List<? extends DocTree> reference) Creates a new | |
| newSerialDataTree | back to summary |
|---|---|
| public SerialDataTree newSerialDataTree(List<? extends DocTree> description) Creates a new
| |
| newSerialFieldTree | back to summary |
|---|---|
| public SerialFieldTree newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description) Creates a new
| |
| newSerialTree | back to summary |
|---|---|
| public SerialTree newSerialTree(List<? extends DocTree> description) Creates a new
| |
| newSinceTree | back to summary |
|---|---|
| public SinceTree newSinceTree(List<? extends DocTree> text) Creates a new | |
| newSnippetTree | back to summary |
|---|---|
| public SnippetTree newSnippetTree(List<? extends DocTree> attributes, TextTree text) Creates a new
| |
| newSpecTree | back to summary |
|---|---|
| public SpecTree newSpecTree(TextTree url, List<? extends DocTree> title) Creates a new | |
| newStartElementTree | back to summary |
|---|---|
| public StartElementTree newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing) Creates a new
| |
| newSummaryTree | back to summary |
|---|---|
| public default SummaryTree newSummaryTree(List<? extends DocTree> summary) Creates a new Implementation Specification This implementation throws
| |
| newSystemPropertyTree | back to summary |
|---|---|
| public SystemPropertyTree newSystemPropertyTree(Name propertyName) Creates a new
| |
| newTextTree | back to summary |
|---|---|
| public TextTree newTextTree(String text) Creates a new | |
| newThrowsTree | back to summary |
|---|---|
| public ThrowsTree newThrowsTree(ReferenceTree name, List<? extends DocTree> description) Creates a new
| |
| newUnknownBlockTagTree | back to summary |
|---|---|
| public UnknownBlockTagTree newUnknownBlockTagTree(Name name, List<? extends DocTree> content) Creates a new
| |
| newUnknownInlineTagTree | back to summary |
|---|---|
| public UnknownInlineTagTree newUnknownInlineTagTree(Name name, List<? extends DocTree> content) Creates a new
| |
| newUsesTree | back to summary |
|---|---|
| public UsesTree newUsesTree(ReferenceTree name, List<? extends DocTree> description) Creates a new
| |
| newValueTree | back to summary |
|---|---|
| public ValueTree newValueTree(ReferenceTree ref) Creates a new
| |
| newValueTree | back to summary |
|---|---|
| public default ValueTree newValueTree(TextTree format, ReferenceTree ref) Creates a new Implementation Specification This implementation calls
| |
| newVersionTree | back to summary |
|---|---|
| public VersionTree newVersionTree(List<? extends DocTree> text) Creates a new
| |