Class SimpleDocTreeVisitor<R,P>
java.lang.Object
com.sun.source.util.SimpleDocTreeVisitor<R,P>
- Type Parameters:
R
- the return type of this visitor's methods. UseVoid
for visitors that do not need to return results.P
- the type of the additional parameter to this visitor's methods. UseVoid
for 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 R
The default value, returned by thedefault action
. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Creates a visitor, with a DEFAULT_VALUE ofnull
.protected
SimpleDocTreeVisitor
(R defaultValue) Creates a visitor, with a specified DEFAULT_VALUE. -
Method Summary
Modifier and TypeMethodDescriptionprotected R
defaultAction
(DocTree node, P p) The default action, used by all visit methods that are not overridden.final R
Invokes the appropriate visit method specific to the type of the node.final R
Invokes the appropriate visit method on each of a sequence of nodes.visitAttribute
(AttributeTree node, P p) Visits anAttributeTree
node.visitAuthor
(AuthorTree node, P p) Visits anAuthorTree
node.visitComment
(CommentTree node, P p) Visits aCommentTree
node.visitDeprecated
(DeprecatedTree node, P p) Visits aDeprecatedTree
node.visitDocComment
(DocCommentTree node, P p) Visits aDocCommentTree
node.visitDocRoot
(DocRootTree node, P p) Visits aDocRootTree
node.visitDocType
(DocTypeTree node, P p) Visits aDocTypeTree
node.visitEndElement
(EndElementTree node, P p) Visits anEndElementTree
node.visitEntity
(EntityTree node, P p) Visits anEntityTree
node.visitErroneous
(ErroneousTree node, P p) Visits anErroneousTree
node.visitEscape
(EscapeTree node, P p) Visits anEscapeTree
node.visitHidden
(HiddenTree node, P p) Visits aHiddenTree
node.visitIdentifier
(IdentifierTree node, P p) Visits anIdentifierTree
node.visitIndex
(IndexTree node, P p) Visits anIndexTree
node.visitInheritDoc
(InheritDocTree node, P p) Visits anInheritDocTree
node.Visits aLinkTree
node.visitLiteral
(LiteralTree node, P p) Visits anLiteralTree
node.visitOther
(DocTree node, P p) Visits an unknown type ofDocTree
node.visitParam
(ParamTree node, P p) Visits aParamTree
node.visitProvides
(ProvidesTree node, P p) Visits aProvidesTree
node.visitRawText
(RawTextTree node, P p) Visits aRawTextTree
node.visitReference
(ReferenceTree node, P p) Visits aReferenceTree
node.visitReturn
(ReturnTree node, P p) Visits aReturnTree
node.Visits aSeeTree
node.visitSerial
(SerialTree node, P p) Visits aSerialTree
node.visitSerialData
(SerialDataTree node, P p) Visits aSerialDataTree
node.visitSerialField
(SerialFieldTree node, P p) Visits aSerialFieldTree
node.visitSince
(SinceTree node, P p) Visits aSinceTree
node.visitSnippet
(SnippetTree node, P p) Visits aSnippetTree
node.Visits aSpecTree
node.visitStartElement
(StartElementTree node, P p) Visits aStartElementTree
node.visitSummary
(SummaryTree node, P p) Visits aSummaryTree
node.visitSystemProperty
(SystemPropertyTree node, P p) Visits aSystemPropertyTree
node.Visits aTextTree
node.visitThrows
(ThrowsTree node, P p) Visits aThrowsTree
node.visitUnknownBlockTag
(UnknownBlockTagTree node, P p) Visits anUnknownBlockTagTree
node.visitUnknownInlineTag
(UnknownInlineTagTree node, P p) Visits anUnknownInlineTagTree
node.Visits aUsesTree
node.visitValue
(ValueTree node, P p) Visits aValueTree
node.visitVersion
(VersionTree node, P p) Visits aVersionTree
node.Methods declared in class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Modifier and TypeMethodDescriptionprotected Object
clone()
Creates and returns a copy of this object.boolean
Indicates whether some other object is "equal to" this one.protected void
finalize()
Deprecated, for removal: This API element is subject to removal in a future version.Finalization is deprecated and subject to removal in a future release.final Class
<?> getClass()
Returns the runtime class of thisObject
.int
hashCode()
Returns a hash code value for this object.final void
notify()
Wakes up a single thread that is waiting on this object's monitor.final void
Wakes up all threads that are waiting on this object's monitor.toString()
Returns a string representation of the object.final void
wait()
Causes the current thread to wait until it is awakened, typically by being notified or interrupted.final void
wait
(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.final void
wait
(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
-
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
-
visit
-
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 anAttributeTree
node.- Specified by:
visitAttribute
in 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 anAuthorTree
node.- Specified by:
visitAuthor
in 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 aCommentTree
node.- Specified by:
visitComment
in 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 aDeprecatedTree
node.- Specified by:
visitDeprecated
in 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 aDocCommentTree
node.- Specified by:
visitDocComment
in 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 aDocRootTree
node.- Specified by:
visitDocRoot
in 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 aDocTypeTree
node.- Specified by:
visitDocType
in 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 anEndElementTree
node.- Specified by:
visitEndElement
in 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 anEntityTree
node.- Specified by:
visitEntity
in 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 anErroneousTree
node.- Specified by:
visitErroneous
in 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 anEscapeTree
node.- Specified by:
visitEscape
in 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 aHiddenTree
node.- Specified by:
visitHidden
in 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 anIdentifierTree
node.- Specified by:
visitIdentifier
in 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 anIndexTree
node.- Specified by:
visitIndex
in 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 anInheritDocTree
node.- Specified by:
visitInheritDoc
in interfaceDocTreeVisitor<R,
P> - Implementation Requirements:
- This implementation calls
defaultAction
. - Parameters:
node
- the node being visitedp
- a parameter value- Returns:
- the result of
defaultAction
-
visitLink
-
visitLiteral
Visits anLiteralTree
node.- Specified by:
visitLiteral
in 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 aParamTree
node.- Specified by:
visitParam
in 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 aProvidesTree
node.- Specified by:
visitProvides
in 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
-
visitRawText
Visits aRawTextTree
node.- Specified by:
visitRawText
in interfaceDocTreeVisitor<R,
P> - Implementation Requirements:
- This implementation calls
defaultAction
. - Parameters:
node
- the node being visitedp
- a parameter value- Returns:
- the result of
defaultAction
- Since:
- 23
-
visitReference
Visits aReferenceTree
node.- Specified by:
visitReference
in 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 aReturnTree
node.- Specified by:
visitReturn
in interfaceDocTreeVisitor<R,
P> - Implementation Requirements:
- This implementation calls
defaultAction
. - Parameters:
node
- the node being visitedp
- a parameter value- Returns:
- the result of
defaultAction
-
visitSee
-
visitSerial
Visits aSerialTree
node.- Specified by:
visitSerial
in 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 aSerialDataTree
node.- Specified by:
visitSerialData
in 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 aSerialFieldTree
node.- Specified by:
visitSerialField
in 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 aSinceTree
node.- Specified by:
visitSince
in 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 aSnippetTree
node.- Specified by:
visitSnippet
in 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 aSpecTree
node.- Specified by:
visitSpec
in 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 aStartElementTree
node.- Specified by:
visitStartElement
in 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 aSummaryTree
node.- Specified by:
visitSummary
in 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 aSystemPropertyTree
node.- Specified by:
visitSystemProperty
in 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
-
visitThrows
Visits aThrowsTree
node.- Specified by:
visitThrows
in 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 anUnknownBlockTagTree
node.- Specified by:
visitUnknownBlockTag
in 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 anUnknownInlineTagTree
node.- Specified by:
visitUnknownInlineTag
in interfaceDocTreeVisitor<R,
P> - Implementation Requirements:
- This implementation calls
defaultAction
. - Parameters:
node
- the node being visitedp
- a parameter value- Returns:
- the result of
defaultAction
-
visitUses
-
visitValue
Visits aValueTree
node.- Specified by:
visitValue
in 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 aVersionTree
node.- Specified by:
visitVersion
in 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 ofDocTree
node. This can occur if the set of tags evolves and new kinds of nodes are added to theDocTree
hierarchy.- Specified by:
visitOther
in interfaceDocTreeVisitor<R,
P> - Implementation Requirements:
- This implementation calls
defaultAction
. - Parameters:
node
- the node being visitedp
- a parameter value- Returns:
- the result of
defaultAction
-