模块 jdk.compiler

软件包 com.sun.source.util

Class SimpleDocTreeVisitor<R,P>

java.lang.Object

com.sun.source.util.SimpleDocTreeVisitor<R,P>

参数类型

R - 此访问者方法的返回类型。 对于不需要返回结果的访问者，请使用Void 。

P - 此访问者方法的附加参数的类型。 对于不需要其他参数的访问者，请使用Void 。

实现的所有接口

DocTreeVisitor<R,P>

public class SimpleDocTreeVisitor<R,P>
extends Object
implements DocTreeVisitor<R,P>

树节点的简单访问者。

从以下版本开始：

1.8

字段汇总

字段

变量和类型	字段	描述
protected R	DEFAULT_VALUE	默认值，由 default action返回。

构造方法摘要

构造方法

变量	构造器	描述
protected	SimpleDocTreeVisitor()	创建一个访问者，DEFAULT_VALUE为 null 。
protected	SimpleDocTreeVisitor(R defaultValue)	创建具有指定DEFAULT_VALUE的访问者。

方法摘要

变量和类型	方法	描述
protected R	defaultAction(DocTree node, P p)	默认操作，由未被覆盖的所有访问方法使用。
R	visit(DocTree node, P p)	调用特定于节点类型的适当访问方法。
R	visit(Iterable<? extends DocTree> nodes, P p)	在每个节点序列上调用适当的访问方法。
R	visitAttribute(AttributeTree node, P p)	访问AttributeTree节点。
R	visitAuthor(AuthorTree node, P p)	访问AuthorTree节点。
R	visitComment(CommentTree node, P p)	访问CommentTree节点。
R	visitDeprecated(DeprecatedTree node, P p)	访问DeprecatedTree节点。
R	visitDocComment(DocCommentTree node, P p)	访问DocCommentTree节点。
R	visitDocRoot(DocRootTree node, P p)	访问DocRootTree节点。
R	visitDocType(DocTypeTree node, P p)	访问DocTypeTree节点。
R	visitEndElement(EndElementTree node, P p)	访问EndElementTree节点。
R	visitEntity(EntityTree node, P p)	访问EntityTree节点。
R	visitErroneous(ErroneousTree node, P p)	访问ErroneousTree节点。
R	visitHidden(HiddenTree node, P p)	访问HiddenTree节点。
R	visitIdentifier(IdentifierTree node, P p)	访问IdentifierTree节点。
R	visitIndex(IndexTree node, P p)	访问IndexTree节点。
R	visitInheritDoc(InheritDocTree node, P p)	访问InheritDocTree节点。
R	visitLink(LinkTree node, P p)	访问LinkTree节点。
R	visitLiteral(LiteralTree node, P p)	访问LiteralTree节点。
R	visitOther(DocTree node, P p)	访问未知类型的DocTree节点。
R	visitParam(ParamTree node, P p)	访问ParamTree节点。
R	visitProvides(ProvidesTree node, P p)	访问ProvideTree节点。
R	visitReference(ReferenceTree node, P p)	访问ReferenceTree节点。
R	visitReturn(ReturnTree node, P p)	访问ReturnTree节点。
R	visitSee(SeeTree node, P p)	访问SeeTree节点。
R	visitSerial(SerialTree node, P p)	访问SerialTree节点。
R	visitSerialData(SerialDataTree node, P p)	访问SerialDataTree节点。
R	visitSerialField(SerialFieldTree node, P p)	访问SerialFieldTree节点。
R	visitSince(SinceTree node, P p)	访问SinceTree节点。
R	visitStartElement(StartElementTree node, P p)	访问StartElementTree节点。
R	visitSummary(SummaryTree node, P p)	访问SummaryTree节点。
R	visitText(TextTree node, P p)	访问TextTree节点。
R	visitThrows(ThrowsTree node, P p)	访问ThrowsTree节点。
R	visitUnknownBlockTag(UnknownBlockTagTree node, P p)	访问UnknownBlockTagTree节点。
R	visitUnknownInlineTag(UnknownInlineTagTree node, P p)	访问UnknownInlineTagTree节点。
R	visitUses(UsesTree node, P p)	访问UsesTree节点。
R	visitValue(ValueTree node, P p)	访问ValueTree节点。
R	visitVersion(VersionTree node, P p)	访问VersionTreeTree节点。

声明方法的类 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细信息

DEFAULT_VALUE

protected final R DEFAULT_VALUE

默认值，由 default action返回。

构造方法详细信息

SimpleDocTreeVisitor

protected SimpleDocTreeVisitor()

创建一个访问者，DEFAULT_VALUE为 null 。

SimpleDocTreeVisitor

protected SimpleDocTreeVisitor(R defaultValue)

创建具有指定DEFAULT_VALUE的访问者。

参数

defaultValue - 默认操作返回的默认值。

方法详细信息

defaultAction

protected R defaultAction(DocTree node,
                          P p)

默认操作，由未被覆盖的所有访问方法使用。

参数

node - 正在访问的节点

p - 传递给visit方法的参数值

结果

从visit方法返回的结果值

visit

public final R visit(DocTree node,
                     P p)

调用特定于节点类型的适当访问方法。

参数

node - 要分派的节点

p - 要传递给适当的访问方法的参数

结果

该值从适当的访问方法返回

visit

public final R visit(Iterable<? extends DocTree> nodes,
                     P p)

在每个节点序列上调用适当的访问方法。

参数

nodes - 要分派的节点

p - 要传递给每个适当的访问方法的参数值

结果

从最后一个访问方法返回的值，如果没有调用则返回null。

visitAttribute

public R visitAttribute(AttributeTree node,
                        P p)

访问AttributeTree节点。 此实现调用defaultAction 。

Specified by:

visitAttribute接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitAuthor

public R visitAuthor(AuthorTree node,
                     P p)

访问AuthorTree节点。 此实现调用defaultAction 。

Specified by:

visitAuthor接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitComment

public R visitComment(CommentTree node,
                      P p)

访问CommentTree节点。 此实现调用defaultAction 。

Specified by:

visitComment接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitDeprecated

public R visitDeprecated(DeprecatedTree node,
                         P p)

访问DeprecatedTree节点。 该实现调用defaultAction 。

Specified by:

visitDeprecated接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitDocComment

public R visitDocComment(DocCommentTree node,
                         P p)

访问DocCommentTree节点。 该实现调用defaultAction 。

Specified by:

visitDocComment接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitDocRoot

public R visitDocRoot(DocRootTree node,
                      P p)

访问DocRootTree节点。 此实现调用defaultAction 。

Specified by:

visitDocRoot接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitDocType

public R visitDocType(DocTypeTree node,
                      P p)

访问DocTypeTree节点。

Specified by:

visitDocType接口 DocTreeVisitor<R,P>

实现要求：

该实现调用 defaultAction 。

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

从以下版本开始：

10

visitEndElement

public R visitEndElement(EndElementTree node,
                         P p)

访问EndElementTree节点。 此实现调用defaultAction 。

Specified by:

visitEndElement接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitEntity

public R visitEntity(EntityTree node,
                     P p)

访问EntityTree节点。 此实现调用defaultAction 。

Specified by:

visitEntity接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitErroneous

public R visitErroneous(ErroneousTree node,
                        P p)

访问ErroneousTree节点。 该实现调用defaultAction 。

Specified by:

visitErroneous接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitHidden

public R visitHidden(HiddenTree node,
                     P p)

访问HiddenTree节点。 此实现调用defaultAction 。

Specified by:

visitHidden接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

从以下版本开始：

9

visitIdentifier

public R visitIdentifier(IdentifierTree node,
                         P p)

访问IdentifierTree节点。 此实现调用defaultAction 。

Specified by:

visitIdentifier接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitIndex

public R visitIndex(IndexTree node,
                    P p)

访问IndexTree节点。 此实现调用defaultAction 。

Specified by:

visitIndex接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

从以下版本开始：

9

visitInheritDoc

public R visitInheritDoc(InheritDocTree node,
                         P p)

访问InheritDocTree节点。 此实现调用defaultAction 。

Specified by:

visitInheritDoc接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitLink

public R visitLink(LinkTree node,
                   P p)

访问LinkTree节点。 此实现调用defaultAction 。

Specified by:

visitLink接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitLiteral

public R visitLiteral(LiteralTree node,
                      P p)

访问LiteralTree节点。 此实现调用defaultAction 。

Specified by:

visitLiteral接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitParam

public R visitParam(ParamTree node,
                    P p)

访问ParamTree节点。 此实现调用defaultAction 。

Specified by:

visitParam接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitProvides

public R visitProvides(ProvidesTree node,
                       P p)

访问ProvideTree节点。 此实现调用defaultAction 。

Specified by:

visitProvides接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

从以下版本开始：

9

visitReference

public R visitReference(ReferenceTree node,
                        P p)

访问ReferenceTree节点。 该实现调用defaultAction 。

Specified by:

visitReference接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitReturn

public R visitReturn(ReturnTree node,
                     P p)

访问ReturnTree节点。 该实现调用defaultAction 。

Specified by:

visitReturn接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitSee

public R visitSee(SeeTree node,
                  P p)

访问SeeTree节点。 此实现调用defaultAction 。

Specified by:

visitSee接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitSerial

public R visitSerial(SerialTree node,
                     P p)

访问SerialTree节点。 此实现调用defaultAction 。

Specified by:

visitSerial接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitSerialData

public R visitSerialData(SerialDataTree node,
                         P p)

访问SerialDataTree节点。 此实现调用defaultAction 。

Specified by:

visitSerialData在界面 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitSerialField

public R visitSerialField(SerialFieldTree node,
                          P p)

访问SerialFieldTree节点。 该实现调用defaultAction 。

Specified by:

visitSerialField接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitSince

public R visitSince(SinceTree node,
                    P p)

访问SinceTree节点。 此实现调用defaultAction 。

Specified by:

visitSince接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitStartElement

public R visitStartElement(StartElementTree node,
                           P p)

访问StartElementTree节点。 此实现调用defaultAction 。

Specified by:

visitStartElement在界面 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitSummary

public R visitSummary(SummaryTree node,
                      P p)

访问SummaryTree节点。 此实现调用defaultAction 。

Specified by:

visitSummary接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

从以下版本开始：

10

visitText

public R visitText(TextTree node,
                   P p)

访问TextTree节点。 此实现调用defaultAction 。

Specified by:

visitText接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitThrows

public R visitThrows(ThrowsTree node,
                     P p)

访问ThrowsTree节点。 此实现调用defaultAction 。

Specified by:

visitThrows在界面 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitUnknownBlockTag

public R visitUnknownBlockTag(UnknownBlockTagTree node,
                              P p)

访问UnknownBlockTagTree节点。 此实现调用defaultAction 。

Specified by:

visitUnknownBlockTag接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitUnknownInlineTag

public R visitUnknownInlineTag(UnknownInlineTagTree node,
                               P p)

访问UnknownInlineTagTree节点。 此实现调用defaultAction 。

Specified by:

visitUnknownInlineTag接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitUses

public R visitUses(UsesTree node,
                   P p)

访问UsesTree节点。 此实现调用defaultAction 。

Specified by:

visitUses ，界面 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

从以下版本开始：

9

visitValue

public R visitValue(ValueTree node,
                    P p)

访问ValueTree节点。 该实现调用defaultAction 。

Specified by:

visitValue接口 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitVersion

public R visitVersion(VersionTree node,
                      P p)

访问VersionTreeTree节点。 此实现调用defaultAction 。

Specified by:

visitVersion在界面 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction

visitOther

public R visitOther(DocTree node,
                    P p)

访问未知类型的DocTree节点。 如果标记集发展并且将新类型的节点添加到DocTree层次结构中，则会发生这种情况。 该实现调用defaultAction 。

Specified by:

visitOther在界面 DocTreeVisitor<R,P>

参数

node - 正在访问的节点

p - 参数值

结果

结果 defaultAction