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.@Exported public class SimpleDocTreeVisitor<R,P> extends Object implements DocTreeVisitor<R,P>
Modifier and Type | Field and Description |
---|---|
protected R |
DEFAULT_VALUE
The default value, returned by the
default action . |
Modifier | Constructor and Description |
---|---|
protected |
SimpleDocTreeVisitor()
Creates a visitor, with a DEFAULT_VALUE of
null . |
protected |
SimpleDocTreeVisitor(R defaultValue)
Creates a visitor, with a specified DEFAULT_VALUE.
|
Modifier and Type | Method and Description |
---|---|
protected R |
defaultAction(DocTree node,
P p)
The default action, used by all visit methods that are not overridden.
|
R |
visit(DocTree node,
P p)
Invokes the appropriate visit method specific to the type of the node.
|
R |
visit(Iterable<? extends DocTree> nodes,
P p)
Invokes the appropriate visit method on each of a sequence of nodes.
|
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 |
visitIdentifier(IdentifierTree node,
P p)
Visits an IdentifierTree 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.
|
protected final R DEFAULT_VALUE
default action
.protected SimpleDocTreeVisitor()
null
.protected SimpleDocTreeVisitor(R defaultValue)
defaultValue
- the default value to be returned by the default action.protected R defaultAction(DocTree node, P p)
node
- the node being visitedp
- the parameter value passed to the visit methodpublic final R visit(DocTree node, P p)
node
- the node on which to dispatchp
- a parameter to be passed to the appropriate visit methodpublic final R visit(Iterable<? extends DocTree> nodes, P p)
nodes
- the nodes on which to dispatchp
- a parameter value to be passed to each appropriate visit methodpublic R visitAttribute(AttributeTree node, P p)
defaultAction
.visitAttribute
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitAuthor(AuthorTree node, P p)
defaultAction
.visitAuthor
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitComment(CommentTree node, P p)
defaultAction
.visitComment
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitDeprecated(DeprecatedTree node, P p)
defaultAction
.visitDeprecated
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitDocComment(DocCommentTree node, P p)
defaultAction
.visitDocComment
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitDocRoot(DocRootTree node, P p)
defaultAction
.visitDocRoot
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitEndElement(EndElementTree node, P p)
defaultAction
.visitEndElement
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitEntity(EntityTree node, P p)
defaultAction
.visitEntity
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitErroneous(ErroneousTree node, P p)
defaultAction
.visitErroneous
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitIdentifier(IdentifierTree node, P p)
defaultAction
.visitIdentifier
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitInheritDoc(InheritDocTree node, P p)
defaultAction
.visitInheritDoc
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitLink(LinkTree node, P p)
defaultAction
.visitLink
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitLiteral(LiteralTree node, P p)
defaultAction
.visitLiteral
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitParam(ParamTree node, P p)
defaultAction
.visitParam
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitReference(ReferenceTree node, P p)
defaultAction
.visitReference
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitReturn(ReturnTree node, P p)
defaultAction
.visitReturn
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitSee(SeeTree node, P p)
defaultAction
.visitSee
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitSerial(SerialTree node, P p)
defaultAction
.visitSerial
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitSerialData(SerialDataTree node, P p)
defaultAction
.visitSerialData
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitSerialField(SerialFieldTree node, P p)
defaultAction
.visitSerialField
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitSince(SinceTree node, P p)
defaultAction
.visitSince
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitStartElement(StartElementTree node, P p)
defaultAction
.visitStartElement
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitText(TextTree node, P p)
defaultAction
.visitText
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitThrows(ThrowsTree node, P p)
defaultAction
.visitThrows
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitUnknownBlockTag(UnknownBlockTagTree node, P p)
defaultAction
.visitUnknownBlockTag
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitUnknownInlineTag(UnknownInlineTagTree node, P p)
defaultAction
.visitUnknownInlineTag
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitValue(ValueTree node, P p)
defaultAction
.visitValue
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitVersion(VersionTree node, P p)
defaultAction
.visitVersion
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
public R visitOther(DocTree node, P p)
DocTree
hierarchy. This implementation calls defaultAction
.visitOther
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuedefaultAction
Copyright © 2005, 2015, Oracle and/or its affiliates. All rights reserved.
DRAFT internal-b87