Uses of Interface
com.sun.source.doctree.DocTree
Package
Description
Provides interfaces to represent documentation comments as abstract syntax
trees (AST).
Provides utilities for operations on abstract syntax trees (AST).
The Doclet API provides an environment which, in conjunction with
the Language Model API and Compiler Tree API, allows clients
to inspect the source-level structures of programs and
libraries, including API comments embedded in the source.
-
Uses of DocTree in com.sun.source.doctree
Modifier and TypeInterfaceDescriptioninterface
A tree node for an attribute in an HTML element or tag.interface
A tree node for an@author
block tag.interface
A tree node used as the base class for the different types of block tags.interface
An embedded HTML comment.interface
A tree node for an@deprecated
block tag.interface
The top-level representation of a documentation comment.interface
A tree node for an@docRoot
inline tag.interface
A tree node for adoctype
declaration.interface
A tree node for the end of an HTML element.interface
A tree node for an HTML entity.interface
A tree node to stand in for malformed text.interface
A tree node for a character represented by an escape sequence.interface
A tree node for an@hidden
block tag.interface
An identifier in a documentation comment.interface
A tree node for an@index
inline tag.interface
A tree node for an@inheritDoc
inline tag.interface
A tree node used as the base class for the different types of inline tags.interface
A tree node for an@link
or@linkplain
inline tag.interface
A tree node for an@literal
or@code
inline tag.interface
A tree node for an@param
block tag.interface
A tree node for a@provides
block tag.interface
A tree node for a reference to a Java language element.interface
A tree node for an@return
block tag.interface
A tree node for an@see
block tag.interface
A tree node for an@serialData
block tag.interface
A tree node for an@serialField
block tag.interface
A tree node for an@serial
block tag.interface
A tree node for an@since
block tag.interface
A tree node for an@snippet
inline tag.interface
A tree node for an@spec
block tag.interface
A tree node for the start of an HTML element.interface
A tree node for an@summary
inline tag.interface
A tree node for an@systemProperty
inline tag.interface
A tree node for plain text.interface
A tree node for an@exception
or@throws
block tag.interface
A tree node for an unrecognized block tag.interface
A tree node for an unrecognized inline tag.interface
A tree node for an@uses
block tag.interface
A tree node for an@value
inline tag.interface
A tree node for an@version
block tag.Modifier and TypeMethodDescriptionSnippetTree.getAttributes()
Returns the list of the attributes of the@snippet
tag.StartElementTree.getAttributes()
Returns any attributes defined by this element.DocCommentTree.getBlockTags()
Returns the block tags for a documentation comment.DeprecatedTree.getBody()
Returns the description explaining why an item is deprecated.DocCommentTree.getBody()
Returns the body of a documentation comment, appearing after the first sentence, and before any block tags.HiddenTree.getBody()
Returns the description explaining why an item is hidden.SinceTree.getBody()
Returns the text explaining the availability of the item being documented.VersionTree.getBody()
Returns the body of the tag.UnknownBlockTagTree.getContent()
Returns the content of an unrecognized block tag.UnknownInlineTagTree.getContent()
Returns the content of an unrecognized inline tag.IndexTree.getDescription()
Returns the description, if any.ParamTree.getDescription()
Returns the description of the parameter.ProvidesTree.getDescription()
Returns a description of the service type being provided by the module.ReturnTree.getDescription()
Returns the description of the return value of a method.SerialDataTree.getDescription()
Returns the description of the serial data.SerialFieldTree.getDescription()
Returns the description of the serial field.SerialTree.getDescription()
Returns the description of the field, or the word "include" or "exclude".ThrowsTree.getDescription()
Returns a description of the reasons why the exception may be thrown.UsesTree.getDescription()
Returns a description of the use of service type within the module.DocCommentTree.getFirstSentence()
Returns the first sentence of a documentation comment.DocCommentTree.getFullBody()
Returns the entire body of a documentation comment, appearing before any block tags, including the first sentence.LinkTree.getLabel()
Returns the label, if any, of the link.AuthorTree.getName()
Returns the name of the author.DocCommentTree.getPostamble()
Returns a list of trees containing the content (if any) following the content of the documentation comment.DocCommentTree.getPreamble()
Returns a list of trees containing the content (if any) preceding the content of the documentation comment.SeeTree.getReference()
Returns the reference.SummaryTree.getSummary()
Returns the summary or the first line of a comment.SpecTree.getTitle()
Returns the title.AttributeTree.getValue()
Modifier and TypeMethodDescriptionDocTreeVisitor.visitOther
(DocTree node, P p) Visits an unknown type ofDocTree
node. -
Uses of DocTree in com.sun.source.util
Modifier and TypeMethodDescriptionDocTreeFactory.getFirstSentence
(List<? extends DocTree> list) Gets the first sentence contained in a list of content.DocTrees.getFirstSentence
(List<? extends DocTree> list) Returns the list ofDocTree
representing the first sentence of a comment.DocTreePath.iterator()
Modifier and TypeMethodDescriptionprotected R
SimpleDocTreeVisitor.defaultAction
(DocTree node, P p) The default action, used by all visit methods that are not overridden.long
DocSourcePositions.getEndPosition
(CompilationUnitTree file, DocCommentTree comment, DocTree tree) Returns the ending position of the tree within the comment within the file.static DocTreePath
DocTreePath.getPath
(DocTreePath path, DocTree target) Returns a documentation tree path for a tree node within a subtree identified by aDocTreePath
object, ornull
if the node is not found.static DocTreePath
DocTreePath.getPath
(TreePath treePath, DocCommentTree doc, DocTree target) Returns a documentation tree path for a tree node within a compilation unit, ornull
if the node is not found.long
DocSourcePositions.getStartPosition
(CompilationUnitTree file, DocCommentTree comment, DocTree tree) Returns the starting position of the tree within the comment within the file.DocTreeFactory.newIndexTree
(DocTree term, List<? extends DocTree> description) Creates a newIndexTree
object, to represent an{@index }
tag.abstract void
DocTrees.printMessage
(Diagnostic.Kind kind, CharSequence msg, DocTree t, DocCommentTree c, CompilationUnitTree root) Prints a message of the specified kind at the location of the tree within the provided compilation unit.Scans a single node.Scans a single node.final R
Invokes the appropriate visit method specific to the type of the node.DocTreeScanner.visitOther
(DocTree node, P p) Visits an unknown type ofDocTree
node.SimpleDocTreeVisitor.visitOther
(DocTree node, P p) Visits an unknown type ofDocTree
node.Modifier and TypeMethodDescriptionDocTreeFactory.getFirstSentence
(List<? extends DocTree> list) Gets the first sentence contained in a list of content.DocTrees.getFirstSentence
(List<? extends DocTree> list) Returns the list ofDocTree
representing the first sentence of a comment.DocTreeFactory.newAttributeTree
(Name name, AttributeTree.ValueKind vkind, List<? extends DocTree> value) Creates a newAttributeTree
object, to represent an attribute in an HTML element or tag.DocTreeFactory.newAuthorTree
(List<? extends DocTree> name) Creates a newAuthorTree
object, to represent an@author
tag.DocTreeFactory.newDeprecatedTree
(List<? extends DocTree> text) Creates a newDeprecatedTree
object, to represent an@deprecated
tag.DocTreeFactory.newDocCommentTree
(List<? extends DocTree> fullBody, List<? extends DocTree> tags) Creates a newDocCommentTree
object, to represent a complete doc comment.DocTreeFactory.newDocCommentTree
(List<? extends DocTree> fullBody, List<? extends DocTree> tags, List<? extends DocTree> preamble, List<? extends DocTree> postamble) Creates a newDocCommentTree
object, to represent the entire doc comment.DocTreeFactory.newExceptionTree
(ReferenceTree name, List<? extends DocTree> description) Creates a newThrowsTree
object, to represent an@exception
tag.DocTreeFactory.newHiddenTree
(List<? extends DocTree> text) Creates a newHiddenTree
object, to represent an@hidden
tag.DocTreeFactory.newIndexTree
(DocTree term, List<? extends DocTree> description) Creates a newIndexTree
object, to represent an{@index }
tag.DocTreeFactory.newLinkPlainTree
(ReferenceTree ref, List<? extends DocTree> label) Creates a newLinkTree
object, to represent a{@linkplain }
tag.DocTreeFactory.newLinkTree
(ReferenceTree ref, List<? extends DocTree> label) Creates a newLinkTree
object, to represent a{@link }
tag.DocTreeFactory.newParamTree
(boolean isTypeParameter, IdentifierTree name, List<? extends DocTree> description) Creates a newParamTree
object, to represent a@param
tag.DocTreeFactory.newProvidesTree
(ReferenceTree name, List<? extends DocTree> description) Creates a newProvidesTree
object, to represent a@provides
tag.default ReturnTree
DocTreeFactory.newReturnTree
(boolean isInline, List<? extends DocTree> description) Creates a newReturnTree
object, to represent a@return
tag or{@return}
tag.DocTreeFactory.newReturnTree
(List<? extends DocTree> description) Creates a newReturnTree
object, to represent a@return
tag.DocTreeFactory.newSeeTree
(List<? extends DocTree> reference) Creates a newSeeTree
object, to represent a@see
tag.DocTreeFactory.newSerialDataTree
(List<? extends DocTree> description) Creates a newSerialDataTree
object, to represent a@serialData
tag.DocTreeFactory.newSerialFieldTree
(IdentifierTree name, ReferenceTree type, List<? extends DocTree> description) Creates a newSerialFieldTree
object, to represent a@serialField
tag.DocTreeFactory.newSerialTree
(List<? extends DocTree> description) Creates a newSerialTree
object, to represent a@serial
tag.DocTreeFactory.newSinceTree
(List<? extends DocTree> text) Creates a newSinceTree
object, to represent a@since
tag.DocTreeFactory.newSnippetTree
(List<? extends DocTree> attributes, TextTree text) Creates a newSnippetTree
object, to represent a{@snippet }
tag.DocTreeFactory.newSpecTree
(TextTree url, List<? extends DocTree> title) Creates a newSpecTree
object, to represent an@spec
tag.DocTreeFactory.newStartElementTree
(Name name, List<? extends DocTree> attrs, boolean selfClosing) Creates a newStartElementTree
object, to represent the start of an HTML element.default SummaryTree
DocTreeFactory.newSummaryTree
(List<? extends DocTree> summary) Creates a newSummaryTree
object, to represent a{@summary }
tag.DocTreeFactory.newThrowsTree
(ReferenceTree name, List<? extends DocTree> description) Creates a newThrowsTree
object, to represent a@throws
tag.DocTreeFactory.newUnknownBlockTagTree
(Name name, List<? extends DocTree> content) Creates a newUnknownBlockTagTree
object, to represent an unrecognized block tag.DocTreeFactory.newUnknownInlineTagTree
(Name name, List<? extends DocTree> content) Creates a newUnknownInlineTagTree
object, to represent an unrecognized inline tag.DocTreeFactory.newUsesTree
(ReferenceTree name, List<? extends DocTree> description) Creates a newUsesTree
object, to represent a@uses
tag.DocTreeFactory.newVersionTree
(List<? extends DocTree> text) Creates a newVersionTree
object, to represent a{@version }
tag.Scans a sequence of nodes.final R
Invokes the appropriate visit method on each of a sequence of nodes.ModifierConstructorDescriptionDocTreePath
(DocTreePath p, DocTree t) Creates aDocTreePath
for a child node. -
Uses of DocTree in jdk.javadoc.doclet