Uses of Interface
com.sun.source.doctree.DocTree

Packages that use DocTree

Package	Description
com.sun.source.doctree	Provides interfaces to represent documentation comments as abstract syntax trees (AST).
com.sun.source.util	Provides utilities for operations on abstract syntax trees (AST).

Uses of DocTree in com.sun.source.doctree

Subinterfaces of DocTree in com.sun.source.doctree

Modifier and Type	Interface and Description
interface	AttributeTree A tree node for an attribute in an HTML element.
interface	AuthorTree A tree node for an @author block tag.
interface	BlockTagTree A tree node used as the base class for the different types of block tags.
interface	CommentTree An embedded HTML comment.
interface	DeprecatedTree A tree node for an @deprecated block tag.
interface	DocCommentTree The top level representation of a documentation comment.
interface	DocRootTree A tree node for an @docroot inline tag.
interface	EndElementTree A tree node for the end of an HTML element.
interface	EntityTree A tree node for an HTML entity.
interface	ErroneousTree A tree node to stand in for a malformed text
interface	IdentifierTree An identifier in a documentation comment.
interface	InheritDocTree A tree node for an @inheritDoc inline tag.
interface	InlineTagTree A tree node used as the base class for the different types of inline tags.
interface	LinkTree A tree node for an @link or @linkplain inline tag.
interface	LiteralTree A tree node for an @literal or @code inline tag.
interface	ParamTree A tree node for an @param block tag.
interface	ReferenceTree A tree node to a reference to a Java language element.
interface	ReturnTree A tree node for an @return block tag.
interface	SeeTree A tree node for an @see block tag.
interface	SerialDataTree A tree node for an @serialData block tag.
interface	SerialFieldTree A tree node for an @serialData block tag.
interface	SerialTree A tree node for an @serial block tag.
interface	SinceTree A tree node for an @since block tag.
interface	StartElementTree A tree node for the start of an HTML element.
interface	TextTree A tree node for plain text.
interface	ThrowsTree A tree node for an @exception or @throws block tag.
interface	UnknownBlockTagTree A tree node for an unrecognized inline tag.
interface	UnknownInlineTagTree A tree node for an unrecognized inline tag.
interface	ValueTree A tree node for an @value inline tag.
interface	VersionTree A tree node for an @version block tag.

Methods in com.sun.source.doctree that return types with arguments of type DocTree

Modifier and Type	Method and Description
java.util.List<? extends DocTree>	StartElementTree.getAttributes()
java.util.List<? extends DocTree>	DocCommentTree.getBlockTags()
java.util.List<? extends DocTree>	VersionTree.getBody()
java.util.List<? extends DocTree>	SinceTree.getBody()
java.util.List<? extends DocTree>	DocCommentTree.getBody()
java.util.List<? extends DocTree>	DeprecatedTree.getBody()
java.util.List<? extends DocTree>	UnknownInlineTagTree.getContent()
java.util.List<? extends DocTree>	UnknownBlockTagTree.getContent()
java.util.List<? extends DocTree>	ThrowsTree.getDescription()
java.util.List<? extends DocTree>	SerialTree.getDescription()
java.util.List<? extends DocTree>	SerialFieldTree.getDescription()
java.util.List<? extends DocTree>	SerialDataTree.getDescription()
java.util.List<? extends DocTree>	ReturnTree.getDescription()
java.util.List<? extends DocTree>	ParamTree.getDescription()
java.util.List<? extends DocTree>	DocCommentTree.getFirstSentence()
java.util.List<? extends DocTree>	LinkTree.getLabel()
java.util.List<? extends DocTree>	AuthorTree.getName()
java.util.List<? extends DocTree>	SeeTree.getReference()
java.util.List<? extends DocTree>	AttributeTree.getValue()

Methods in com.sun.source.doctree with parameters of type DocTree

Modifier and Type	Method and Description
R	DocTreeVisitor.visitOther(DocTree node, P p)

Uses of DocTree in com.sun.source.util

Methods in com.sun.source.util that return DocTree

Modifier and Type	Method and Description
DocTree	DocTreePath.getLeaf() Get the leaf node for this path.

Methods in com.sun.source.util that return types with arguments of type DocTree

Modifier and Type	Method and Description
java.util.Iterator<DocTree>	DocTreePath.iterator()

Methods in com.sun.source.util with parameters of type DocTree

Modifier and Type	Method and Description
protected R	SimpleDocTreeVisitor.defaultAction(DocTree node, P p)
long	DocSourcePositions.getEndPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) Gets the ending position of the tree within the comment within the file.
static DocTreePath	DocTreePath.getPath(DocTreePath path, DocTree target) Gets a documentation tree path for a tree node within a subtree identified by a DocTreePath object.
static DocTreePath	DocTreePath.getPath(TreePath treePath, DocCommentTree doc, DocTree target) Gets a documentation tree path for a tree node within a compilation unit.
long	DocSourcePositions.getStartPosition(CompilationUnitTree file, DocCommentTree comment, DocTree tree) Gets the starting position of the tree within the comment within the file.
abstract void	DocTrees.printMessage(Diagnostic.Kind kind, java.lang.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
R	DocTreeScanner.scan(DocTree node, P p) Scan a single node.
R	DocTreePathScanner.scan(DocTree tree, P p) Scan a single node.
R	SimpleDocTreeVisitor.visit(DocTree node, P p)
R	SimpleDocTreeVisitor.visitOther(DocTree node, P p)
R	DocTreeScanner.visitOther(DocTree node, P p)

Method parameters in com.sun.source.util with type arguments of type DocTree

Modifier and Type	Method and Description
R	DocTreeScanner.scan(java.lang.Iterable<? extends DocTree> nodes, P p) Scan a list of nodes.
R	SimpleDocTreeVisitor.visit(java.lang.Iterable<? extends DocTree> nodes, P p)

Constructors in com.sun.source.util with parameters of type DocTree

Constructor and Description
DocTreePath(DocTreePath p, DocTree t) Creates a DocTreePath for a child node.