Module jdk.compiler

Package com.sun.source.doctree

Interface DocTreeVisitor<R,P>

类型参数:

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

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

所有已知的实现类:

DocTreePathScanner, DocTreeScanner, SimpleDocTreeVisitor

       public interface DocTreeVisitor<R,P>
      

以访问者设计模式的方式访问树。实现此接口的类用于在编译时未知树的种类时操作树。当将访问者传递给树的accept方法时，将调用最适用于该树的visitXyz方法。

实现此接口的类可能会或可能不会在附加参数p为null时抛出NullPointerException；有关详细信息，请参阅实现类的文档。

警告: 可能会向此接口添加方法以适应将来版本的Java编程语言中添加的新的、当前未知的文档注释结构。因此，直接实现此接口的访问者类可能与平台的未来版本不兼容。

自版本:

1.8

Method Summary

Modifier and Type	Method	Description
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节点。
default 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节点。
default R	visitEscape(EscapeTree node, P p)	访问EscapeTree节点。
default R	visitHidden(HiddenTree node, P p)	访问HiddenTree节点。
R	visitIdentifier(IdentifierTree node, P p)	访问IdentifierTree节点。
default 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节点。
default R	visitProvides(ProvidesTree node, P p)	访问ProvidesTree节点。
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节点。
default R	visitSnippet(SnippetTree node, P p)	访问SnippetTree节点。
default R	visitSpec(SpecTree node, P p)	访问SpecTree节点。
R	visitStartElement(StartElementTree node, P p)	访问StartElementTree节点。
default R	visitSummary(SummaryTree node, P p)	访问SummaryTree节点。
default R	visitSystemProperty(SystemPropertyTree node, P p)	访问SystemPropertyTree节点。
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节点。
default R	visitUses(UsesTree node, P p)	访问UsesTree节点。
R	visitValue(ValueTree node, P p)	访问ValueTree节点。
R	visitVersion(VersionTree node, P p)	访问VersionTree节点。

Method Details

visitAttribute

             R visitAttribute(AttributeTree node, P p)
            

访问AttributeTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitAuthor

             R visitAuthor(AuthorTree node, P p)
            

访问AuthorTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitComment

             R visitComment(CommentTree node, P p)
            

访问CommentTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitDeprecated

             R visitDeprecated(DeprecatedTree node, P p)
            

访问DeprecatedTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitDocComment

             R visitDocComment(DocCommentTree node, P p)
            

访问DocCommentTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitDocRoot

             R visitDocRoot(DocRootTree node, P p)
            

访问DocRootTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitDocType

             default R visitDocType(DocTypeTree node, P p)
            

访问DocTypeTree节点。

实现要求:

通过调用visitOther(node, p)访问提供的DocTypeTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

自版本:

10

visitEndElement

             R visitEndElement(EndElementTree node, P p)
            

访问EndElementTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitEntity

             R visitEntity(EntityTree node, P p)
            

访问EntityTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitErroneous

             R visitErroneous(ErroneousTree node, P p)
            

访问ErroneousTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitEscape

             default R visitEscape(EscapeTree node, P p)
            

访问EscapeTree节点。

实现要求:

通过调用visitOther(node, p)访问提供的EscapeTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

自版本:

21

visitHidden

             default R visitHidden(HiddenTree node, P p)
            

访问HiddenTree节点。

实现要求:

通过调用visitOther(node, p)访问提供的HiddenTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

自版本:

9

visitIdentifier

             R visitIdentifier(IdentifierTree node, P p)
            

访问IdentifierTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitIndex

             default R visitIndex(IndexTree node, P p)
            

访问IndexTree节点。

实现要求:

通过调用visitOther(node, p)访问提供的IndexTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

自版本:

9

visitInheritDoc

             R visitInheritDoc(InheritDocTree node, P p)
            

访问InheritDocTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitLink

             R visitLink(LinkTree node, P p)
            

访问LinkTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitLiteral

             R visitLiteral(LiteralTree node, P p)
            

访问LiteralTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitParam

             R visitParam(ParamTree node, P p)
            

访问ParamTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitProvides

             default R visitProvides(ProvidesTree node, P p)
            

访问ProvidesTree节点。

实现要求:

通过调用visitOther(node, p)访问提供的ProvidesTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

自版本:

9

visitReference

             R visitReference(ReferenceTree node, P p)
            

访问ReferenceTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitReturn

             R visitReturn(ReturnTree node, P p)
            

访问ReturnTree节点。

参数:

node - 正在访问的节点

p - 一个参数值

返回:

一个结果值

visitSee

             R visitSee(SeeTree node, P p)
            

访问SeeTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitSerial

             R visitSerial(SerialTree node, P p)
            

访问一个SerialTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitSerialData

             R visitSerialData(SerialDataTree node, P p)
            

访问一个SerialDataTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitSerialField

             R visitSerialField(SerialFieldTree node, P p)
            

访问一个SerialFieldTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitSince

             R visitSince(SinceTree node, P p)
            

访问一个SinceTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitSnippet

             default R visitSnippet(SnippetTree node, P p)
            

访问一个SnippetTree节点。

实现要求:

通过调用visitOther(node, p)访问提供的SnippetTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

自:

18

visitSpec

             default R visitSpec(SpecTree node, P p)
            

访问一个SpecTree节点。

实现要求:

通过调用visitOther(node, p)访问提供的SpecTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

自:

20

visitStartElement

             R visitStartElement(StartElementTree node, P p)
            

访问一个StartElementTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitSummary

             default R visitSummary(SummaryTree node, P p)
            

访问一个SummaryTree节点。

实现要求:

通过调用visitOther(node, p)访问提供的SummaryTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

自:

10

visitSystemProperty

             default R visitSystemProperty(SystemPropertyTree node, P p)
            

访问一个SystemPropertyTree节点。

实现要求:

通过调用visitOther(node, p)访问提供的SystemPropertyTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

自:

12

visitText

             R visitText(TextTree node, P p)
            

访问一个TextTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitThrows

             R visitThrows(ThrowsTree node, P p)
            

访问一个ThrowsTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitUnknownBlockTag

             R visitUnknownBlockTag(UnknownBlockTagTree node, P p)
            

访问一个UnknownBlockTagTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitUnknownInlineTag

             R visitUnknownInlineTag(UnknownInlineTagTree node, P p)
            

访问一个UnknownInlineTagTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitUses

             default R visitUses(UsesTree node, P p)
            

访问一个UsesTree节点。

实现要求:

通过调用visitOther(node, p)访问一个UsesTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

自:

9

visitValue

             R visitValue(ValueTree node, P p)
            

访问一个ValueTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitVersion

             R visitVersion(VersionTree node, P p)
            

访问一个VersionTree节点。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值

visitOther

             R visitOther(DocTree node, P p)
            

访问一个未知类型的DocTree节点。如果标签集发生变化并且DocTree层次结构中添加了新类型的节点，则可能会发生这种情况。

参数:

node - 被访问的节点

p - 一个参数值

返回:

一个结果值