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. Use- Voidfor visitors that do not need to return results.
- P- the type of the additional parameter to this visitor's methods. Use- Voidfor visitors that do not need an additional parameter.
- All Implemented Interfaces:
- DocTreeVisitor<R,- P> 
A simple visitor for tree nodes.
- Since:
- 1.8
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected final RThe default value, returned by thedefault action.
- 
Constructor SummaryConstructorsModifierConstructorDescriptionprotectedCreates a visitor, with a DEFAULT_VALUE ofnull.protectedSimpleDocTreeVisitor(R defaultValue) Creates a visitor, with a specified DEFAULT_VALUE.
- 
Method SummaryModifier 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.visitRawText(RawTextTree node, P p) Visits aRawTextTreenode.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_VALUEThe default value, returned by thedefault action.
 
- 
- 
Constructor Details- 
SimpleDocTreeVisitorprotected SimpleDocTreeVisitor()Creates a visitor, with a DEFAULT_VALUE ofnull.
- 
SimpleDocTreeVisitorCreates a visitor, with a specified DEFAULT_VALUE.- Parameters:
- defaultValue- the default value to be returned by the default action
 
 
- 
- 
Method Details- 
defaultAction
- 
visit
- 
visitInvokes the appropriate visit method on each of a sequence of nodes.- Parameters:
- nodes- the nodes on which to dispatch
- p- 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
 
- 
visitAttributeVisits anAttributeTreenode.- Specified by:
- visitAttributein interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitAuthorVisits anAuthorTreenode.- Specified by:
- visitAuthorin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitCommentVisits aCommentTreenode.- Specified by:
- visitCommentin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitDeprecatedVisits aDeprecatedTreenode.- Specified by:
- visitDeprecatedin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitDocCommentVisits aDocCommentTreenode.- Specified by:
- visitDocCommentin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitDocRootVisits aDocRootTreenode.- Specified by:
- visitDocRootin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitDocTypeVisits aDocTypeTreenode.- Specified by:
- visitDocTypein interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
- Since:
- 10
 
- 
visitEndElementVisits anEndElementTreenode.- Specified by:
- visitEndElementin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitEntityVisits anEntityTreenode.- Specified by:
- visitEntityin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitErroneousVisits anErroneousTreenode.- Specified by:
- visitErroneousin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitEscapeVisits anEscapeTreenode.- Specified by:
- visitEscapein interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
- Since:
- 21
 
- 
visitHiddenVisits aHiddenTreenode.- Specified by:
- visitHiddenin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
- Since:
- 9
 
- 
visitIdentifierVisits anIdentifierTreenode.- Specified by:
- visitIdentifierin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitIndexVisits anIndexTreenode.- Specified by:
- visitIndexin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
- Since:
- 9
 
- 
visitInheritDocVisits anInheritDocTreenode.- Specified by:
- visitInheritDocin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitLink
- 
visitLiteralVisits anLiteralTreenode.- Specified by:
- visitLiteralin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitParamVisits aParamTreenode.- Specified by:
- visitParamin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitProvidesVisits aProvidesTreenode.- Specified by:
- visitProvidesin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
- Since:
- 9
 
- 
visitRawTextVisits aRawTextTreenode.- Specified by:
- visitRawTextin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
- Since:
- 23
 
- 
visitReferenceVisits aReferenceTreenode.- Specified by:
- visitReferencein interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitReturnVisits aReturnTreenode.- Specified by:
- visitReturnin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitSee
- 
visitSerialVisits aSerialTreenode.- Specified by:
- visitSerialin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitSerialDataVisits aSerialDataTreenode.- Specified by:
- visitSerialDatain interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitSerialFieldVisits aSerialFieldTreenode.- Specified by:
- visitSerialFieldin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitSinceVisits aSinceTreenode.- Specified by:
- visitSincein interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitSnippetVisits aSnippetTreenode.- Specified by:
- visitSnippetin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
- Since:
- 18
 
- 
visitSpecVisits aSpecTreenode.- Specified by:
- visitSpecin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
- Since:
- 20
 
- 
visitStartElementVisits aStartElementTreenode.- Specified by:
- visitStartElementin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitSummaryVisits aSummaryTreenode.- Specified by:
- visitSummaryin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
- Since:
- 10
 
- 
visitSystemPropertyVisits aSystemPropertyTreenode.- Specified by:
- visitSystemPropertyin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
- Since:
- 12
 
- 
visitText
- 
visitThrowsVisits aThrowsTreenode.- Specified by:
- visitThrowsin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitUnknownBlockTagVisits anUnknownBlockTagTreenode.- Specified by:
- visitUnknownBlockTagin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitUnknownInlineTagVisits anUnknownInlineTagTreenode.- Specified by:
- visitUnknownInlineTagin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitUses
- 
visitValueVisits aValueTreenode.- Specified by:
- visitValuein interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitVersionVisits aVersionTreenode.- Specified by:
- visitVersionin interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
- 
visitOtherVisits 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 interface- DocTreeVisitor<R,- P> 
- Implementation Requirements:
- This implementation calls defaultAction.
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- the result of defaultAction
 
 
-