public class DocTreeScanner<R,P> extends Object implements DocTreeVisitor<R,P>
The default implementation of the visitXYZ methods will determine a result as follows:
null
.
scan
on that child. The child may be a simple node
or itself a list of nodes.
scan
each child in turn, and then combining the
result of each scan after the first with the cumulative result
so far, as determined by the reduce(R, R)
method. Each child may be either
a simple node of a list of nodes. The default behavior of the reduce
method is such that the result of the visitXYZ method will be the result of
the last child scanned.
Here is an example to count the number of erroneous nodes in a tree:
class CountErrors extends DocTreeScanner<Integer,Void> { @Override public Integer visitErroneous(ErroneousTree node, Void p) { return 1; } @Override public Integer reduce(Integer r1, Integer r2) { return (r1 == null ? 0 : r1) + (r2 == null ? 0 : r2); } }
Constructor and Description |
---|
DocTreeScanner() |
Modifier and Type | Method and Description |
---|---|
R |
reduce(R r1,
R r2)
Reduces two results into a combined result.
|
R |
scan(DocTree node,
P p)
Scans a single node.
|
R |
scan(Iterable<? extends DocTree> nodes,
P p)
Scans 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 |
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.
|
public R scan(DocTree node, P p)
node
- the node to be scannedp
- a parameter value passed to the visit methodpublic R scan(Iterable<? extends DocTree> nodes, P p)
nodes
- the nodes to be scannedp
- a parameter value to be passed to the visit method for each nodereduce
method.public R reduce(R r1, R r2)
r1
- the first of the values to be combinedr2
- the second of the values to be combinedpublic R visitAttribute(AttributeTree node, P p)
null
.visitAttribute
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitAuthor(AuthorTree node, P p)
visitAuthor
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitComment(CommentTree node, P p)
null
.visitComment
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitDeprecated(DeprecatedTree node, P p)
visitDeprecated
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitDocComment(DocCommentTree node, P p)
visitDocComment
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitDocRoot(DocRootTree node, P p)
null
.visitDocRoot
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitEndElement(EndElementTree node, P p)
null
.visitEndElement
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitEntity(EntityTree node, P p)
null
.visitEntity
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitErroneous(ErroneousTree node, P p)
null
.visitErroneous
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitHidden(HiddenTree node, P p)
visitHidden
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitIdentifier(IdentifierTree node, P p)
null
.visitIdentifier
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitIndex(IndexTree node, P p)
null
.visitIndex
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitInheritDoc(InheritDocTree node, P p)
null
.visitInheritDoc
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitLink(LinkTree node, P p)
visitLink
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitLiteral(LiteralTree node, P p)
null
.visitLiteral
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitParam(ParamTree node, P p)
visitParam
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitReference(ReferenceTree node, P p)
null
.visitReference
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitReturn(ReturnTree node, P p)
visitReturn
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitSee(SeeTree node, P p)
visitSee
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitSerial(SerialTree node, P p)
visitSerial
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitSerialData(SerialDataTree node, P p)
visitSerialData
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitSerialField(SerialFieldTree node, P p)
visitSerialField
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitSince(SinceTree node, P p)
visitSince
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitStartElement(StartElementTree node, P p)
visitStartElement
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitText(TextTree node, P p)
null
.visitText
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitThrows(ThrowsTree node, P p)
visitThrows
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitUnknownBlockTag(UnknownBlockTagTree node, P p)
visitUnknownBlockTag
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitUnknownInlineTag(UnknownInlineTagTree node, P p)
visitUnknownInlineTag
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitValue(ValueTree node, P p)
visitValue
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitVersion(VersionTree node, P p)
visitVersion
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter valuepublic R visitOther(DocTree node, P p)
DocTree
hierarchy. This implementation returns null
.visitOther
in interface DocTreeVisitor<R,P>
node
- the node being visitedp
- a parameter value
Copyright © 2005, 2016, Oracle and/or its affiliates. All rights reserved.
DRAFT 9-ea+126