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>
A simple visitor for tree nodes.
- Since:
- 1.8
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final RThe default value, returned by thedefault action. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCreates a visitor, with a DEFAULT_VALUE ofnull.protectedSimpleDocTreeVisitor(R defaultValue) Creates a visitor, with a specified DEFAULT_VALUE. -
Method Summary
Modifier and TypeMethodDescriptionprotected RdefaultAction(DocTree node, P p) The default action, used by all visit methods that are not overridden.final RInvokes the appropriate visit method specific to the type of the node.final RInvokes the appropriate visit method on each of a sequence of nodes.visitAttribute(AttributeTree node, P p) Visits anAttributeTreenode.visitAuthor(AuthorTree node, P p) Visits anAuthorTreenode.visitComment(CommentTree node, P p) Visits aCommentTreenode.visitDeprecated(DeprecatedTree node, P p) Visits aDeprecatedTreenode.visitDocComment(DocCommentTree node, P p) Visits aDocCommentTreenode.visitDocRoot(DocRootTree node, P p) Visits aDocRootTreenode.visitDocType(DocTypeTree node, P p) Visits aDocTypeTreenode.visitEndElement(EndElementTree node, P p) Visits anEndElementTreenode.visitEntity(EntityTree node, P p) Visits anEntityTreenode.visitErroneous(ErroneousTree node, P p) Visits anErroneousTreenode.visitEscape(EscapeTree node, P p) Visits anEscapeTreenode.visitHidden(HiddenTree node, P p) Visits aHiddenTreenode.visitIdentifier(IdentifierTree node, P p) Visits anIdentifierTreenode.visitIndex(IndexTree node, P p) Visits anIndexTreenode.visitInheritDoc(InheritDocTree node, P p) Visits anInheritDocTreenode.Visits aLinkTreenode.visitLiteral(LiteralTree node, P p) Visits anLiteralTreenode.visitOther(DocTree node, P p) Visits an unknown type ofDocTreenode.visitParam(ParamTree node, P p) Visits aParamTreenode.visitProvides(ProvidesTree node, P p) Visits aProvidesTreenode.visitReference(ReferenceTree node, P p) Visits aReferenceTreenode.visitReturn(ReturnTree node, P p) Visits aReturnTreenode.Visits aSeeTreenode.visitSerial(SerialTree node, P p) Visits aSerialTreenode.visitSerialData(SerialDataTree node, P p) Visits aSerialDataTreenode.visitSerialField(SerialFieldTree node, P p) Visits aSerialFieldTreenode.visitSince(SinceTree node, P p) Visits aSinceTreenode.visitSnippet(SnippetTree node, P p) Visits aSnippetTreenode.Visits aSpecTreenode.visitStartElement(StartElementTree node, P p) Visits aStartElementTreenode.visitSummary(SummaryTree node, P p) Visits aSummaryTreenode.visitSystemProperty(SystemPropertyTree node, P p) Visits aSystemPropertyTreenode.Visits aTextTreenode.visitThrows(ThrowsTree node, P p) Visits aThrowsTreenode.visitUnknownBlockTag(UnknownBlockTagTree node, P p) Visits anUnknownBlockTagTreenode.visitUnknownInlineTag(UnknownInlineTagTree node, P p) Visits anUnknownInlineTagTreenode.Visits aUsesTreenode.visitValue(ValueTree node, P p) Visits aValueTreenode.visitVersion(VersionTree node, P p) Visits aVersionTreenode.
-
Field Details
-
DEFAULT_VALUE
The default value, returned by thedefault action.
-
-
Constructor Details
-
SimpleDocTreeVisitor
protected SimpleDocTreeVisitor()Creates a visitor, with a DEFAULT_VALUE ofnull. -
SimpleDocTreeVisitor
Creates a visitor, with a specified DEFAULT_VALUE.- Parameters:
defaultValue- the default value to be returned by the default action
-
-
Method Details
-
defaultAction
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
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
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
Visits anAttributeTreenode.- Specified by:
visitAttributein interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitAuthor
Visits anAuthorTreenode.- Specified by:
visitAuthorin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitComment
Visits aCommentTreenode.- Specified by:
visitCommentin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitDeprecated
Visits aDeprecatedTreenode.- Specified by:
visitDeprecatedin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitDocComment
Visits aDocCommentTreenode.- Specified by:
visitDocCommentin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitDocRoot
Visits aDocRootTreenode.- Specified by:
visitDocRootin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitDocType
Visits aDocTypeTreenode.- 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
Visits anEndElementTreenode.- Specified by:
visitEndElementin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitEntity
Visits anEntityTreenode.- Specified by:
visitEntityin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitErroneous
Visits anErroneousTreenode.- Specified by:
visitErroneousin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitEscape
Visits anEscapeTreenode.- Specified by:
visitEscapein interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 21
-
visitHidden
Visits aHiddenTreenode.- Specified by:
visitHiddenin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 9
-
visitIdentifier
Visits anIdentifierTreenode.- Specified by:
visitIdentifierin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitIndex
Visits anIndexTreenode.- Specified by:
visitIndexin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 9
-
visitInheritDoc
Visits anInheritDocTreenode.- Specified by:
visitInheritDocin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitLink
Visits aLinkTreenode.- Specified by:
visitLinkin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitLiteral
Visits anLiteralTreenode.- Specified by:
visitLiteralin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitParam
Visits aParamTreenode.- Specified by:
visitParamin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitProvides
Visits aProvidesTreenode.- Specified by:
visitProvidesin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 9
-
visitReference
Visits aReferenceTreenode.- Specified by:
visitReferencein interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitReturn
Visits aReturnTreenode.- Specified by:
visitReturnin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSee
Visits aSeeTreenode.- Specified by:
visitSeein interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSerial
Visits aSerialTreenode.- Specified by:
visitSerialin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSerialData
Visits aSerialDataTreenode.- Specified by:
visitSerialDatain interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSerialField
Visits aSerialFieldTreenode.- Specified by:
visitSerialFieldin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSince
Visits aSinceTreenode.- Specified by:
visitSincein interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSnippet
Visits aSnippetTreenode.- Specified by:
visitSnippetin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 18
-
visitSpec
Visits aSpecTreenode.- Specified by:
visitSpecin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 20
-
visitStartElement
Visits aStartElementTreenode.- Specified by:
visitStartElementin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitSummary
Visits aSummaryTreenode.- Specified by:
visitSummaryin 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
-
visitSystemProperty
Visits aSystemPropertyTreenode.- Specified by:
visitSystemPropertyin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 12
-
visitText
Visits aTextTreenode.- Specified by:
visitTextin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitThrows
Visits aThrowsTreenode.- Specified by:
visitThrowsin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitUnknownBlockTag
Visits anUnknownBlockTagTreenode.- Specified by:
visitUnknownBlockTagin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitUnknownInlineTag
Visits anUnknownInlineTagTreenode.- Specified by:
visitUnknownInlineTagin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitUses
Visits aUsesTreenode.- Specified by:
visitUsesin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction - Since:
- 9
-
visitValue
Visits aValueTreenode.- Specified by:
visitValuein interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitVersion
Visits aVersionTreenode.- Specified by:
visitVersionin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-
visitOther
Visits an unknown type ofDocTreenode. This can occur if the set of tags evolves and new kinds of nodes are added to theDocTreehierarchy.- Specified by:
visitOtherin interfaceDocTreeVisitor<R,P> - Implementation Requirements:
- This implementation calls
defaultAction. - Parameters:
node- the node being visitedp- a parameter value- Returns:
- the result of
defaultAction
-