OpenJDK 27 · com.sun.tools.javac.tree.DocTreeMaker · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
pack-priv static class	DocTreeMaker.SentenceBreaker

Modifier and Type	Field and Description
private final DocTreeMaker.SentenceBreaker	breaker
public int	pos The position at which subsequent trees will be created.
private final ReferenceParser	referenceParser Utility class to parse reference signatures.
protected static final Context.Key<DocTreeMaker>	treeMakerKey The context key for the tree factory.
private final JavacTrees	trees

Access	Constructor and Description
protected	DocTreeMaker(Context context) Create a tree maker with NOPOS as initial position.

Method Summary

Modifier and Type	Method and Description
public DocTreeMaker	at(int pos) Implements com.sun.source.util.DocTreeFactory.at. Reassign current position.
private static List<DCTree>	cast(List<? extends DocTree> list)
public List<DocTree>	getFirstSentence(List<? extends DocTree> list) Implements com.sun.source.util.DocTreeFactory.getFirstSentence. Gets the first sentence contained in a list of content.
public static DocTreeMaker	instance(Context context) Get the TreeMaker instance.
public DCTree.DCAttribute	newAttributeTree(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value) Implements com.sun.source.util.DocTreeFactory.newAttributeTree. Creates a new `AttributeTree` object, to represent an attribute in an HTML element or tag.
public DCTree.DCAuthor	newAuthorTree(List<? extends DocTree> name) Implements com.sun.source.util.DocTreeFactory.newAuthorTree. Creates a new `AuthorTree` object, to represent an `@author` tag.
public DCTree.DCLiteral	newCodeTree(TextTree text) Implements com.sun.source.util.DocTreeFactory.newCodeTree. Creates a new `LiteralTree` object, to represent a `{@code }` tag.
public DCTree.DCComment	newCommentTree(String text) Implements com.sun.source.util.DocTreeFactory.newCommentTree. Creates a new `CommentTree`, to represent an HTML comment.
public DCTree.DCDeprecated	newDeprecatedTree(List<? extends DocTree> text) Implements com.sun.source.util.DocTreeFactory.newDeprecatedTree. Creates a new `DeprecatedTree` object, to represent an `@deprecated` tag.
public DCTree.DCDocComment	newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags) Implements com.sun.source.util.DocTreeFactory.newDocCommentTree. Creates a new `DocCommentTree` object, to represent a complete doc comment.
public DCTree.DCDocComment	newDocCommentTree(Tokens.Comment comment, List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble)
public DCTree.DCDocComment	newDocCommentTree(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble) Implements com.sun.source.util.DocTreeFactory.newDocCommentTree. Creates a new `DocCommentTree` object, to represent the entire doc comment.
public DCTree.DCDocRoot	newDocRootTree() Implements com.sun.source.util.DocTreeFactory.newDocRootTree. Creates a new `DocRootTree` object, to represent an `{@docRoot}` tag.
public DCTree.DCDocType	newDocTypeTree(String text) Implements com.sun.source.util.DocTreeFactory.newDocTypeTree. Creates a new `DocTypeTree`, to represent a `DOCTYPE` HTML declaration.
public DCTree.DCEndElement	newEndElementTree(Name name) Implements com.sun.source.util.DocTreeFactory.newEndElementTree. Creates a new `EndElement` object, to represent the end of an HTML element.
public DCTree.DCEntity	newEntityTree(Name name) Implements com.sun.source.util.DocTreeFactory.newEntityTree. Creates a new `EntityTree` object, to represent an HTML entity.
public DCTree.DCErroneous	newErroneousTree(String text, Diagnostic<JavaFileObject> diag) Implements com.sun.source.util.DocTreeFactory.newErroneousTree. Creates a new `ErroneousTree` object, to represent some unparseable input.
public DCTree.DCEscape	newEscapeTree(char ch) Implements com.sun.source.util.DocTreeFactory.newEscapeTree. Creates a new `EscapeTree` object, to represent an escaped character.
public DCTree.DCThrows	newExceptionTree(ReferenceTree name, List<? extends DocTree> description) Implements com.sun.source.util.DocTreeFactory.newExceptionTree. Creates a new `ThrowsTree` object, to represent an `@exception` tag.
public DCTree.DCHidden	newHiddenTree(List<? extends DocTree> text) Implements com.sun.source.util.DocTreeFactory.newHiddenTree. Creates a new `HiddenTree` object, to represent an `@hidden` tag.
public DCTree.DCIdentifier	newIdentifierTree(Name name) Implements com.sun.source.util.DocTreeFactory.newIdentifierTree. Creates a new `IdentifierTree` object, to represent an identifier, such as in a `@param` tag.
public DCTree.DCIndex	newIndexTree(DocTree term, List<? extends DocTree> description) Implements com.sun.source.util.DocTreeFactory.newIndexTree. Creates a new `IndexTree` object, to represent an `{@index }` tag.
public DCTree.DCInheritDoc	newInheritDocTree() Implements com.sun.source.util.DocTreeFactory.newInheritDocTree. Creates a new `InheritDocTree` object, to represent an `{@inheritDoc}` tag.
public DCTree.DCInheritDoc	newInheritDocTree(ReferenceTree supertype) Overrides default com.sun.source.util.DocTreeFactory.newInheritDocTree. Creates a new `InheritDocTree` object, to represent an `{@inheritDoc}` tag.
public DCTree.DCLink	newLinkPlainTree(ReferenceTree ref, List<? extends DocTree> label) Implements com.sun.source.util.DocTreeFactory.newLinkPlainTree. Creates a new `LinkTree` object, to represent a `{@linkplain }` tag.
public DCTree.DCLink	newLinkTree(ReferenceTree ref, List<? extends DocTree> label) Implements com.sun.source.util.DocTreeFactory.newLinkTree. Creates a new `LinkTree` object, to represent a `{@link }` tag.
public DCTree.DCLiteral	newLiteralTree(TextTree text) Implements com.sun.source.util.DocTreeFactory.newLiteralTree. Creates a new `LiteralTree` object, to represent a `{@literal }` tag.
public DCTree.DCParam	newParamTree(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description) Implements com.sun.source.util.DocTreeFactory.newParamTree. Creates a new `ParamTree` object, to represent a `@param` tag.
public DCTree.DCProvides	newProvidesTree(ReferenceTree name, List<? extends DocTree> description) Implements com.sun.source.util.DocTreeFactory.newProvidesTree. Creates a new `ProvidesTree` object, to represent a `@provides` tag.
public DCTree.DCRawText	newRawTextTree(DocTree.Kind kind, String text) Implements com.sun.source.util.DocTreeFactory.newRawTextTree. Creates a new `RawTextTree` object, to represent a fragment of uninterpreted raw text.
public DCTree.DCReference	newReferenceTree(String signature) Implements com.sun.source.util.DocTreeFactory.newReferenceTree. Creates a new `ReferenceTree` object, to represent a reference to an API element.
public DCTree.DCReference	newReferenceTree(String signature, ReferenceParser.Reference ref)
public DCTree.DCReturn	newReturnTree(List<? extends DocTree> description) Implements com.sun.source.util.DocTreeFactory.newReturnTree. Creates a new `ReturnTree` object, to represent a `@return` tag.
public DCTree.DCReturn	newReturnTree(boolean isInline, List<? extends DocTree> description) Overrides default com.sun.source.util.DocTreeFactory.newReturnTree. Creates a new `ReturnTree` object, to represent a `@return` tag or `{@return}` tag.
public DCTree.DCSee	newSeeTree(List<? extends DocTree> reference) Implements com.sun.source.util.DocTreeFactory.newSeeTree. Creates a new `SeeTree` object, to represent a `@see` tag.
public DCTree.DCSerialData	newSerialDataTree(List<? extends DocTree> description) Implements com.sun.source.util.DocTreeFactory.newSerialDataTree. Creates a new `SerialDataTree` object, to represent a `@serialData` tag.
public DCTree.DCSerialField	newSerialFieldTree(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description) Implements com.sun.source.util.DocTreeFactory.newSerialFieldTree. Creates a new `SerialFieldTree` object, to represent a `@serialField` tag.
public DCTree.DCSerial	newSerialTree(List<? extends DocTree> description) Implements com.sun.source.util.DocTreeFactory.newSerialTree. Creates a new `SerialTree` object, to represent a `@serial` tag.
public DCTree.DCSince	newSinceTree(List<? extends DocTree> text) Implements com.sun.source.util.DocTreeFactory.newSinceTree. Creates a new `SinceTree` object, to represent a `@since` tag.
public DCTree.DCSnippet	newSnippetTree(List<? extends DocTree> attributes, TextTree text) Implements com.sun.source.util.DocTreeFactory.newSnippetTree. Creates a new `SnippetTree` object, to represent a `{@snippet }` tag.
public DCTree.DCSpec	newSpecTree(TextTree url, List<? extends DocTree> title) Implements com.sun.source.util.DocTreeFactory.newSpecTree. Creates a new `SpecTree` object, to represent an `@spec` tag.
public DCTree.DCStartElement	newStartElementTree(Name name, List<? extends DocTree> attrs, boolean selfClosing) Implements com.sun.source.util.DocTreeFactory.newStartElementTree. Creates a new `StartElementTree` object, to represent the start of an HTML element.
public DCTree.DCSummary	newSummaryTree(List<? extends DocTree> text) Overrides default com.sun.source.util.DocTreeFactory.newSummaryTree. Creates a new `SummaryTree` object, to represent a `{@summary }` tag.
public DCTree.DCSystemProperty	newSystemPropertyTree(Name propertyName) Implements com.sun.source.util.DocTreeFactory.newSystemPropertyTree. Creates a new `SystemPropertyTree` object, to represent a `{@systemProperty }` tag.
public DCTree.DCText	newTextTree(String text) Implements com.sun.source.util.DocTreeFactory.newTextTree. Creates a new `TextTree` object, to represent some plain text.
public DCTree.DCThrows	newThrowsTree(ReferenceTree name, List<? extends DocTree> description) Implements com.sun.source.util.DocTreeFactory.newThrowsTree. Creates a new `ThrowsTree` object, to represent a `@throws` tag.
public DCTree.DCUnknownBlockTag	newUnknownBlockTagTree(Name name, List<? extends DocTree> content) Implements com.sun.source.util.DocTreeFactory.newUnknownBlockTagTree. Creates a new `UnknownBlockTagTree` object, to represent an unrecognized block tag.
public DCTree.DCUnknownInlineTag	newUnknownInlineTagTree(Name name, List<? extends DocTree> content) Implements com.sun.source.util.DocTreeFactory.newUnknownInlineTagTree. Creates a new `UnknownInlineTagTree` object, to represent an unrecognized inline tag.
public DCTree.DCUses	newUsesTree(ReferenceTree name, List<? extends DocTree> description) Implements com.sun.source.util.DocTreeFactory.newUsesTree. Creates a new `UsesTree` object, to represent a `@uses` tag.
public DCTree.DCValue	newValueTree(ReferenceTree ref) Implements com.sun.source.util.DocTreeFactory.newValueTree. Creates a new `ValueTree` object, to represent a `{@value }` tag.
public DCTree.DCValue	newValueTree(TextTree format, ReferenceTree ref) Overrides default com.sun.source.util.DocTreeFactory.newValueTree. Creates a new `ValueTree` object, to represent a `{@value }` tag.
public DCTree.DCVersion	newVersionTree(List<? extends DocTree> text) Implements com.sun.source.util.DocTreeFactory.newVersionTree. Creates a new `VersionTree` object, to represent a `{@version }` tag.
pack-priv Pair<List<DCTree>, List<DCTree>>	splitBody(List<? extends DocTree> list)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class DocTreeMaker

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary