- 
- 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 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 an tree'sacceptmethod, thevisitXyzmethod most applicable to that tree is invoked.Classes implementing this interface may or may not throw a NullPointerExceptionif the additional parameterpisnull; 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 SummaryAll Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description 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.default 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.default RvisitHidden(HiddenTree node, P p)Visits a HiddenTree node.RvisitIdentifier(IdentifierTree node, P p)Visits an IdentifierTree node.default 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.default 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.default 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.default 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.
 
- 
- 
- 
Method Detail- 
visitAttributeR visitAttribute(AttributeTree node, P p) Visits an AttributeTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitAuthorR visitAuthor(AuthorTree node, P p) Visits an AuthorTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitCommentR visitComment(CommentTree node, P p) Visits a CommentTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitDeprecatedR visitDeprecated(DeprecatedTree node, P p) Visits a DeprecatedTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitDocCommentR visitDocComment(DocCommentTree node, P p) Visits a DocCommentTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitDocRootR visitDocRoot(DocRootTree node, P p) Visits a DocRootTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitDocTypedefault R visitDocType(DocTypeTree node, P p) Visits a DocTypeTree node.- Implementation Requirements:
- Visits a DocTypeTreenode by callingvisitOther(node, p).
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
- Since:
- 10
 
 - 
visitEndElementR visitEndElement(EndElementTree node, P p) Visits an EndElementTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitEntityR visitEntity(EntityTree node, P p) Visits an EntityTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitErroneousR visitErroneous(ErroneousTree node, P p) Visits an ErroneousTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitHiddendefault R visitHidden(HiddenTree node, P p) Visits a HiddenTree node.- Implementation Requirements:
- Visits a HiddenTreenode by callingvisitOther(node, p).
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
- Since:
- 9
 
 - 
visitIdentifierR visitIdentifier(IdentifierTree node, P p) Visits an IdentifierTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitIndexdefault R visitIndex(IndexTree node, P p) Visits an IndexTree node.- Implementation Requirements:
- Visits an IndexTreenode by callingvisitOther(node, p).
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
- Since:
- 9
 
 - 
visitInheritDocR visitInheritDoc(InheritDocTree node, P p) Visits an InheritDocTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitLinkR visitLink(LinkTree node, P p) Visits a LinkTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitLiteralR visitLiteral(LiteralTree node, P p) Visits an LiteralTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitParamR visitParam(ParamTree node, P p) Visits a ParamTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitProvidesdefault R visitProvides(ProvidesTree node, P p) Visits a ProvidesTree node.- Implementation Requirements:
- Visits a ProvidesTreenode by callingvisitOther(node, p).
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
- Since:
- 9
 
 - 
visitReferenceR visitReference(ReferenceTree node, P p) Visits a ReferenceTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitReturnR visitReturn(ReturnTree node, P p) Visits a ReturnTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitSeeR visitSee(SeeTree node, P p) Visits a SeeTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitSerialR visitSerial(SerialTree node, P p) Visits a SerialTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitSerialDataR visitSerialData(SerialDataTree node, P p) Visits a SerialDataTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitSerialFieldR visitSerialField(SerialFieldTree node, P p) Visits a SerialFieldTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitSinceR visitSince(SinceTree node, P p) Visits a SinceTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitStartElementR visitStartElement(StartElementTree node, P p) Visits a StartElementTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitSummarydefault R visitSummary(SummaryTree node, P p) Visits a SummaryTree node.- Implementation Requirements:
- Visits a SummaryTreenode by callingvisitOther(node, p).
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
- Since:
- 10
 
 - 
visitTextR visitText(TextTree node, P p) Visits a TextTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitThrowsR visitThrows(ThrowsTree node, P p) Visits a ThrowsTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitUnknownBlockTagR visitUnknownBlockTag(UnknownBlockTagTree node, P p) Visits an UnknownBlockTagTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitUnknownInlineTagR visitUnknownInlineTag(UnknownInlineTagTree node, P p) Visits an UnknownInlineTagTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitUsesdefault R visitUses(UsesTree node, P p) Visits a UsesTree node.- Implementation Requirements:
- Visits a UsesTreenode by callingvisitOther(node, p).
- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
- Since:
- 9
 
 - 
visitValueR visitValue(ValueTree node, P p) Visits a ValueTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 - 
visitVersionR visitVersion(VersionTree node, P p) Visits a VersionTreeTree node.- Parameters:
- node- the node being visited
- p- a parameter value
- Returns:
- a result value
 
 
- 
 
-