- 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 Known Implementing Classes:
DocTreePathScanner,DocTreeScanner,SimpleDocTreeVisitor
public interface DocTreeVisitor<R,P>
A visitor of trees, in the style of the visitor design pattern.
Classes implementing this interface are used to operate
on a tree when the kind of tree is unknown at compile time.
When a visitor is passed to a tree's
accept method, the visitXyz method most applicable
to that tree is invoked.
Classes implementing this interface may or may not throw a
NullPointerException if the additional parameter p
is null; see documentation of the implementing class for
details.
WARNING: It is possible that methods will be added to this interface to accommodate new, currently unknown, doc comment structures added to future versions of the Java programming language. Therefore, visitor classes directly implementing this interface may be source incompatible with future versions of the platform.
- Since:
- 1.8
-
Method Summary
Modifier and TypeMethodDescriptionvisitAttribute(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.default RvisitDocType(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.default RvisitEscape(EscapeTree node, P p) Visits anEscapeTreenode.default RvisitHidden(HiddenTree node, P p) Visits aHiddenTreenode.visitIdentifier(IdentifierTree node, P p) Visits anIdentifierTreenode.default RvisitIndex(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.default RvisitProvides(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.default RvisitSnippet(SnippetTree node, P p) Visits aSnippetTreenode.default RVisits aSpecTreenode.visitStartElement(StartElementTree node, P p) Visits aStartElementTreenode.default RvisitSummary(SummaryTree node, P p) Visits aSummaryTreenode.default RvisitSystemProperty(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.default RVisits aUsesTreenode.visitValue(ValueTree node, P p) Visits aValueTreenode.visitVersion(VersionTree node, P p) Visits aVersionTreenode.
-
Method Details
-
visitAttribute
Visits anAttributeTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitAuthor
Visits anAuthorTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitComment
Visits aCommentTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitDeprecated
Visits aDeprecatedTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitDocComment
Visits aDocCommentTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitDocRoot
Visits aDocRootTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitDocType
Visits aDocTypeTreenode.- Implementation Requirements:
- Visits the provided
DocTypeTreenode by callingvisitOther(node, p). - Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
- Since:
- 10
-
visitEndElement
Visits anEndElementTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitEntity
Visits anEntityTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitErroneous
Visits anErroneousTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitEscape
Visits anEscapeTreenode.- Implementation Requirements:
- Visits the provided
EscapeTreenode by callingvisitOther(node, p). - Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
- Since:
- 21
-
visitHidden
Visits aHiddenTreenode.- Implementation Requirements:
- Visits the provided
HiddenTreenode by callingvisitOther(node, p). - Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
- Since:
- 9
-
visitIdentifier
Visits anIdentifierTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitIndex
Visits anIndexTreenode.- Implementation Requirements:
- Visits the provided
IndexTreenode by callingvisitOther(node, p). - Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
- Since:
- 9
-
visitInheritDoc
Visits anInheritDocTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitLink
Visits aLinkTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitLiteral
Visits anLiteralTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitParam
Visits aParamTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitProvides
Visits aProvidesTreenode.- Implementation Requirements:
- Visits the provided
ProvidesTreenode by callingvisitOther(node, p). - Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
- Since:
- 9
-
visitReference
Visits aReferenceTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitReturn
Visits aReturnTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitSee
Visits aSeeTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitSerial
Visits aSerialTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitSerialData
Visits aSerialDataTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitSerialField
Visits aSerialFieldTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitSince
Visits aSinceTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitSnippet
Visits aSnippetTreenode.- Implementation Requirements:
- Visits the provided
SnippetTreenode by callingvisitOther(node, p). - Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
- Since:
- 18
-
visitSpec
Visits aSpecTreenode.- Implementation Requirements:
- Visits the provided
SpecTreenode by callingvisitOther(node, p). - Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
- Since:
- 20
-
visitStartElement
Visits aStartElementTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitSummary
Visits aSummaryTreenode.- Implementation Requirements:
- Visits the provided
SummaryTreenode by callingvisitOther(node, p). - Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
- Since:
- 10
-
visitSystemProperty
Visits aSystemPropertyTreenode.- Implementation Requirements:
- Visits the provided
SystemPropertyTreenode by callingvisitOther(node, p). - Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
- Since:
- 12
-
visitText
Visits aTextTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitThrows
Visits aThrowsTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitUnknownBlockTag
Visits anUnknownBlockTagTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitUnknownInlineTag
Visits anUnknownInlineTagTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitUses
Visits aUsesTreenode.- Implementation Requirements:
- Visits a
UsesTreenode by callingvisitOther(node, p). - Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
- Since:
- 9
-
visitValue
Visits aValueTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitVersion
Visits aVersionTreenode.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-
visitOther
Visits an unknown type ofDocTreenode. This can occur if the set of tags evolves and new kinds of nodes are added to theDocTreehierarchy.- Parameters:
node- the node being visitedp- a parameter value- Returns:
- a result value
-