模块 jdk.compiler

接口 DocTreeVisitor<R,P>

类型参数:
R - 此访问者方法的返回类型。对不需要返回结果的访问者使用Void
P - 此访问者方法的附加参数的类型。 Void 用于不需要额外参数的访问者。
所有已知的实现类:
DocTreePathScanner , DocTreeScanner , SimpleDocTreeVisitor

public interface DocTreeVisitor<R,P>
树木的访客,采用访客设计模式的风格。当编译时树的种类未知时,实现此接口的类用于对树进行操作。当访问者传递给树的 accept 方法时,将调用最适用于该树的 visitXyz 方法。

如果附加参数 pnull ,则实现此接口的类可能会或可能不会抛出 NullPointerException ;有关详细信息,请参阅实现类的文档。

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

自从:
1.8
  • 方法详情

    • 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 - 一个参数值
      返回:
      结果值
    • 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 - 一个参数值
      返回:
      结果值