- java.lang.Object
-
- com.sun.source.util.SimpleDocTreeVisitor<R,P>
-
- Type Parameters:
R- the return type of this visitor's methods. UseVoidfor visitors that do not need to return results.P- the type of the additional parameter to this visitor's methods. UseVoidfor visitors that do not need an additional parameter.
- All Implemented Interfaces:
DocTreeVisitor<R,P>
public class SimpleDocTreeVisitor<R,P> extends Object implements DocTreeVisitor<R,P>
A simple visitor for tree nodes.- Since:
- 1.8
-
-
Field Summary
Fields Modifier and Type Field Description protected RDEFAULT_VALUEThe default value, returned by thedefault action.
-
Constructor Summary
Constructors Modifier Constructor Description protectedSimpleDocTreeVisitor()Creates a visitor, with a DEFAULT_VALUE ofnull.protectedSimpleDocTreeVisitor(R defaultValue)Creates a visitor, with a specified DEFAULT_VALUE.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected RdefaultAction(DocTree node, P p)The default action, used by all visit methods that are not overridden.Rvisit(DocTree node, P p)Invokes the appropriate visit method specific to the type of the node.Rvisit(Iterable<? extends DocTree> nodes, P p)Invokes the appropriate visit method on each of a sequence of nodes.RvisitAttribute(AttributeTree node, P p)Visits an AttributeTree node.RvisitAuthor(AuthorTree node, P p)Visits an AuthorTree node.RvisitComment(CommentTree node, P p)Visits a CommentTree node.RvisitDeprecated(DeprecatedTree node, P p)Visits a DeprecatedTree node.RvisitDocComment(DocCommentTree node, P p)Visits a DocCommentTree node.RvisitDocRoot(DocRootTree node, P p)Visits a DocRootTree node.RvisitDocType(DocTypeTree node, P p)Visits a DocTypeTree node.RvisitEndElement(EndElementTree node, P p)Visits an EndElementTree node.RvisitEntity(EntityTree node, P p)Visits an EntityTree node.RvisitErroneous(ErroneousTree node, P p)Visits an ErroneousTree node.RvisitHidden(HiddenTree node, P p)Visits a HiddenTree node.RvisitIdentifier(IdentifierTree node, P p)Visits an IdentifierTree node.RvisitIndex(IndexTree node, P p)Visits an IndexTree node.RvisitInheritDoc(InheritDocTree node, P p)Visits an InheritDocTree node.RvisitLink(LinkTree node, P p)Visits a LinkTree node.RvisitLiteral(LiteralTree node, P p)Visits an LiteralTree node.RvisitOther(DocTree node, P p)Visits an unknown type of DocTree node.RvisitParam(ParamTree node, P p)Visits a ParamTree node.RvisitProvides(ProvidesTree node, P p)Visits a ProvidesTree node.RvisitReference(ReferenceTree node, P p)Visits a ReferenceTree node.RvisitReturn(ReturnTree node, P p)Visits a ReturnTree node.RvisitSee(SeeTree node, P p)Visits a SeeTree node.RvisitSerial(SerialTree node, P p)Visits a SerialTree node.RvisitSerialData(SerialDataTree node, P p)Visits a SerialDataTree node.RvisitSerialField(SerialFieldTree node, P p)Visits a SerialFieldTree node.RvisitSince(SinceTree node, P p)Visits a SinceTree node.RvisitStartElement(StartElementTree node, P p)Visits a StartElementTree node.RvisitSummary(SummaryTree node, P p)Visits a SummaryTree node.RvisitText(TextTree node, P p)Visits a TextTree node.RvisitThrows(ThrowsTree node, P p)Visits a ThrowsTree node.RvisitUnknownBlockTag(UnknownBlockTagTree node, P p)Visits an UnknownBlockTagTree node.RvisitUnknownInlineTag(UnknownInlineTagTree node, P p)Visits an UnknownInlineTagTree node.RvisitUses(UsesTree node, P p)Visits a UsesTree node.RvisitValue(ValueTree node, P p)Visits a ValueTree node.RvisitVersion(VersionTree node, P p)Visits a VersionTreeTree node.
-
-
-
Field Detail
-
DEFAULT_VALUE
protected final R DEFAULT_VALUE
The default value, returned by thedefault action.
-
-
Constructor Detail
-
SimpleDocTreeVisitor
protected SimpleDocTreeVisitor()
Creates a visitor, with a DEFAULT_VALUE ofnull.
-
SimpleDocTreeVisitor
protected SimpleDocTreeVisitor(R defaultValue)
Creates a visitor, with a specified DEFAULT_VALUE.- Parameters:
defaultValue- the default value to be returned by the default action.
-
-
Method Detail
-
defaultAction
protected R defaultAction(DocTree node, P p)
The default action, used by all visit methods that are not overridden.- Parameters:
node- the node being visitedp- the parameter value passed to the visit method- Returns:
- the result value to be returned from the visit method
-
visit
public final R visit(DocTree node, P p)
Invokes the appropriate visit method specific to the type of the node.- Parameters:
node- the node on which to dispatchp- a parameter to be passed to the appropriate visit method- Returns:
- the value returns from the appropriate visit method
-
visit
public final R visit(Iterable<? extends DocTree> nodes, P p)
Invokes the appropriate visit method on each of a sequence of nodes.- Parameters:
nodes- the nodes on which to dispatchp- a parameter value to be passed to each appropriate visit method- Returns:
- the value return from the last of the visit methods, or null if none were called.
-
visitAttribute
public R visitAttribute(AttributeTree node, P p)
Visits an AttributeTree node. This implementation callsdefaultAction.- Specified by:
visitAttributein interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitAuthor
public R visitAuthor(AuthorTree node, P p)
Visits an AuthorTree node. This implementation callsdefaultAction.- Specified by:
visitAuthorin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitComment
public R visitComment(CommentTree node, P p)
Visits a CommentTree node. This implementation callsdefaultAction.- Specified by:
visitCommentin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitDeprecated
public R visitDeprecated(DeprecatedTree node, P p)
Visits a DeprecatedTree node. This implementation callsdefaultAction.- Specified by:
visitDeprecatedin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitDocComment
public R visitDocComment(DocCommentTree node, P p)
Visits a DocCommentTree node. This implementation callsdefaultAction.- Specified by:
visitDocCommentin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitDocRoot
public R visitDocRoot(DocRootTree node, P p)
Visits a DocRootTree node. This implementation callsdefaultAction.- Specified by:
visitDocRootin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitDocType
public R visitDocType(DocTypeTree node, P p)
Visits a DocTypeTree node.- Specified by:
visitDocTypein interfaceDocTreeVisitor<R,P>- Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 10
-
visitEndElement
public R visitEndElement(EndElementTree node, P p)
Visits an EndElementTree node. This implementation callsdefaultAction.- Specified by:
visitEndElementin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitEntity
public R visitEntity(EntityTree node, P p)
Visits an EntityTree node. This implementation callsdefaultAction.- Specified by:
visitEntityin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitErroneous
public R visitErroneous(ErroneousTree node, P p)
Visits an ErroneousTree node. This implementation callsdefaultAction.- Specified by:
visitErroneousin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitHidden
public R visitHidden(HiddenTree node, P p)
Visits a HiddenTree node. This implementation callsdefaultAction.- Specified by:
visitHiddenin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 9
-
visitIdentifier
public R visitIdentifier(IdentifierTree node, P p)
Visits an IdentifierTree node. This implementation callsdefaultAction.- Specified by:
visitIdentifierin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitIndex
public R visitIndex(IndexTree node, P p)
Visits an IndexTree node. This implementation callsdefaultAction.- Specified by:
visitIndexin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 9
-
visitInheritDoc
public R visitInheritDoc(InheritDocTree node, P p)
Visits an InheritDocTree node. This implementation callsdefaultAction.- Specified by:
visitInheritDocin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitLink
public R visitLink(LinkTree node, P p)
Visits a LinkTree node. This implementation callsdefaultAction.- Specified by:
visitLinkin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitLiteral
public R visitLiteral(LiteralTree node, P p)
Visits an LiteralTree node. This implementation callsdefaultAction.- Specified by:
visitLiteralin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitParam
public R visitParam(ParamTree node, P p)
Visits a ParamTree node. This implementation callsdefaultAction.- Specified by:
visitParamin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitProvides
public R visitProvides(ProvidesTree node, P p)
Visits a ProvidesTree node. This implementation callsdefaultAction.- Specified by:
visitProvidesin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 9
-
visitReference
public R visitReference(ReferenceTree node, P p)
Visits a ReferenceTree node. This implementation callsdefaultAction.- Specified by:
visitReferencein interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitReturn
public R visitReturn(ReturnTree node, P p)
Visits a ReturnTree node. This implementation callsdefaultAction.- Specified by:
visitReturnin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSee
public R visitSee(SeeTree node, P p)
Visits a SeeTree node. This implementation callsdefaultAction.- Specified by:
visitSeein interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSerial
public R visitSerial(SerialTree node, P p)
Visits a SerialTree node. This implementation callsdefaultAction.- Specified by:
visitSerialin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSerialData
public R visitSerialData(SerialDataTree node, P p)
Visits a SerialDataTree node. This implementation callsdefaultAction.- Specified by:
visitSerialDatain interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSerialField
public R visitSerialField(SerialFieldTree node, P p)
Visits a SerialFieldTree node. This implementation callsdefaultAction.- Specified by:
visitSerialFieldin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSince
public R visitSince(SinceTree node, P p)
Visits a SinceTree node. This implementation callsdefaultAction.- Specified by:
visitSincein interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitStartElement
public R visitStartElement(StartElementTree node, P p)
Visits a StartElementTree node. This implementation callsdefaultAction.- Specified by:
visitStartElementin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSummary
public R visitSummary(SummaryTree node, P p)
Visits a SummaryTree node. This implementation callsdefaultAction.- Specified by:
visitSummaryin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 10
-
visitText
public R visitText(TextTree node, P p)
Visits a TextTree node. This implementation callsdefaultAction.- Specified by:
visitTextin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitThrows
public R visitThrows(ThrowsTree node, P p)
Visits a ThrowsTree node. This implementation callsdefaultAction.- Specified by:
visitThrowsin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitUnknownBlockTag
public R visitUnknownBlockTag(UnknownBlockTagTree node, P p)
Visits an UnknownBlockTagTree node. This implementation callsdefaultAction.- Specified by:
visitUnknownBlockTagin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitUnknownInlineTag
public R visitUnknownInlineTag(UnknownInlineTagTree node, P p)
Visits an UnknownInlineTagTree node. This implementation callsdefaultAction.- Specified by:
visitUnknownInlineTagin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitUses
public R visitUses(UsesTree node, P p)
Visits a UsesTree node. This implementation callsdefaultAction.- Specified by:
visitUsesin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 9
-
visitValue
public R visitValue(ValueTree node, P p)
Visits a ValueTree node. This implementation callsdefaultAction.- Specified by:
visitValuein interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitVersion
public R visitVersion(VersionTree node, P p)
Visits a VersionTreeTree node. This implementation callsdefaultAction.- Specified by:
visitVersionin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitOther
public R visitOther(DocTree node, P p)
Visits an unknown type of DocTree node. This can occur if the set of tags evolves and new kinds of nodes are added to theDocTreehierarchy. This implementation callsdefaultAction.- Specified by:
visitOtherin interfaceDocTreeVisitor<R,P>- Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
-