R
- the return type of this visitor's methods. Use Void
for visitors that do not need to return results.P
- the type of the additional parameter to this visitor's
methods. Use Void
for visitors that do not need an
additional parameter.DocTreePathScanner
, DocTreeScanner
, SimpleDocTreeVisitor
public interface DocTreeVisitor<R,P>
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.
Modifier and Type | Method | Description |
---|---|---|
R |
visitAttribute(AttributeTree node,
P p) |
Visits an AttributeTree node.
|
R |
visitAuthor(AuthorTree node,
P p) |
Visits an AuthorTree node.
|
R |
visitComment(CommentTree node,
P p) |
Visits a CommentTree node.
|
R |
visitDeprecated(DeprecatedTree node,
P p) |
Visits a DeprecatedTree node.
|
R |
visitDocComment(DocCommentTree node,
P p) |
Visits a DocCommentTree node.
|
R |
visitDocRoot(DocRootTree node,
P p) |
Visits a DocRootTree node.
|
R |
visitEndElement(EndElementTree node,
P p) |
Visits an EndElementTree node.
|
R |
visitEntity(EntityTree node,
P p) |
Visits an EntityTree node.
|
R |
visitErroneous(ErroneousTree node,
P p) |
Visits an ErroneousTree node.
|
R |
visitHidden(HiddenTree node,
P p) |
Visits a HiddenTree node.
|
R |
visitIdentifier(IdentifierTree node,
P p) |
Visits an IdentifierTree node.
|
R |
visitIndex(IndexTree node,
P p) |
Visits an IndexTree node.
|
R |
visitInheritDoc(InheritDocTree node,
P p) |
Visits an InheritDocTree node.
|
R |
visitLink(LinkTree node,
P p) |
Visits a LinkTree node.
|
R |
visitLiteral(LiteralTree node,
P p) |
Visits an LiteralTree node.
|
R |
visitOther(DocTree node,
P p) |
Visits an unknown type of DocTree node.
|
R |
visitParam(ParamTree node,
P p) |
Visits a ParamTree node.
|
R |
visitReference(ReferenceTree node,
P p) |
Visits a ReferenceTree node.
|
R |
visitReturn(ReturnTree node,
P p) |
Visits a ReturnTree node.
|
R |
visitSee(SeeTree node,
P p) |
Visits a SeeTree node.
|
R |
visitSerial(SerialTree node,
P p) |
Visits a SerialTree node.
|
R |
visitSerialData(SerialDataTree node,
P p) |
Visits a SerialDataTree node.
|
R |
visitSerialField(SerialFieldTree node,
P p) |
Visits a SerialFieldTree node.
|
R |
visitSince(SinceTree node,
P p) |
Visits a SinceTree node.
|
R |
visitStartElement(StartElementTree node,
P p) |
Visits a StartElementTree node.
|
R |
visitText(TextTree node,
P p) |
Visits a TextTree node.
|
R |
visitThrows(ThrowsTree node,
P p) |
Visits a ThrowsTree node.
|
R |
visitUnknownBlockTag(UnknownBlockTagTree node,
P p) |
Visits an UnknownBlockTagTree node.
|
R |
visitUnknownInlineTag(UnknownInlineTagTree node,
P p) |
Visits an UnknownInlineTagTree node.
|
R |
visitValue(ValueTree node,
P p) |
Visits a ValueTree node.
|
R |
visitVersion(VersionTree node,
P p) |
Visits a VersionTreeTree node.
|
R visitAttribute(AttributeTree node, P p)
node
- the node being visitedp
- a parameter valueR visitAuthor(AuthorTree node, P p)
node
- the node being visitedp
- a parameter valueR visitComment(CommentTree node, P p)
node
- the node being visitedp
- a parameter valueR visitDeprecated(DeprecatedTree node, P p)
node
- the node being visitedp
- a parameter valueR visitDocComment(DocCommentTree node, P p)
node
- the node being visitedp
- a parameter valueR visitDocRoot(DocRootTree node, P p)
node
- the node being visitedp
- a parameter valueR visitEndElement(EndElementTree node, P p)
node
- the node being visitedp
- a parameter valueR visitEntity(EntityTree node, P p)
node
- the node being visitedp
- a parameter valueR visitErroneous(ErroneousTree node, P p)
node
- the node being visitedp
- a parameter valueR visitHidden(HiddenTree node, P p)
node
- the node being visitedp
- a parameter valueR visitIdentifier(IdentifierTree node, P p)
node
- the node being visitedp
- a parameter valueR visitIndex(IndexTree node, P p)
node
- the node being visitedp
- a parameter valueR visitInheritDoc(InheritDocTree node, P p)
node
- the node being visitedp
- a parameter valueR visitLink(LinkTree node, P p)
node
- the node being visitedp
- a parameter valueR visitLiteral(LiteralTree node, P p)
node
- the node being visitedp
- a parameter valueR visitParam(ParamTree node, P p)
node
- the node being visitedp
- a parameter valueR visitReference(ReferenceTree node, P p)
node
- the node being visitedp
- a parameter valueR visitReturn(ReturnTree node, P p)
node
- the node being visitedp
- a parameter valueR visitSee(SeeTree node, P p)
node
- the node being visitedp
- a parameter valueR visitSerial(SerialTree node, P p)
node
- the node being visitedp
- a parameter valueR visitSerialData(SerialDataTree node, P p)
node
- the node being visitedp
- a parameter valueR visitSerialField(SerialFieldTree node, P p)
node
- the node being visitedp
- a parameter valueR visitSince(SinceTree node, P p)
node
- the node being visitedp
- a parameter valueR visitStartElement(StartElementTree node, P p)
node
- the node being visitedp
- a parameter valueR visitText(TextTree node, P p)
node
- the node being visitedp
- a parameter valueR visitThrows(ThrowsTree node, P p)
node
- the node being visitedp
- a parameter valueR visitUnknownBlockTag(UnknownBlockTagTree node, P p)
node
- the node being visitedp
- a parameter valueR visitUnknownInlineTag(UnknownInlineTagTree node, P p)
node
- the node being visitedp
- a parameter valueR visitValue(ValueTree node, P p)
node
- the node being visitedp
- a parameter valueR visitVersion(VersionTree node, P p)
node
- the node being visitedp
- a parameter value Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 2005, 2016, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-Debian+0-9b148-1