OpenJDK 1.22 · com.sun.source.doctree.DocTreeVisitor

Method Summary

Modifier and Type	Method and Description
public R	Returns: a result value visitAttribute(AttributeTree the node being visited node, P a parameter value p) Visits an `AttributeTree` node.
public R	Returns: a result value visitAuthor(AuthorTree the node being visited node, P a parameter value p) Visits an `AuthorTree` node.
public R	Returns: a result value visitComment(CommentTree the node being visited node, P a parameter value p) Visits a `CommentTree` node.
public R	Returns: a result value visitDeprecated(DeprecatedTree the node being visited node, P a parameter value p) Visits a `DeprecatedTree` node.
public R	Returns: a result value visitDocComment(DocCommentTree the node being visited node, P a parameter value p) Visits a `DocCommentTree` node.
public R	Returns: a result value visitDocRoot(DocRootTree the node being visited node, P a parameter value p) Visits a `DocRootTree` node.
public default R	Returns: a result value visitDocType(DocTypeTree the node being visited node, P a parameter value p) Visits a `DocTypeTree` node.
public R	Returns: a result value visitEndElement(EndElementTree the node being visited node, P a parameter value p) Visits an `EndElementTree` node.
public R	Returns: a result value visitEntity(EntityTree the node being visited node, P a parameter value p) Visits an `EntityTree` node.
public R	Returns: a result value visitErroneous(ErroneousTree the node being visited node, P a parameter value p) Visits an `ErroneousTree` node.
public default R	Returns: a result value visitEscape(EscapeTree the node being visited node, P a parameter value p) Visits an `EscapeTree` node.
public default R	Returns: a result value visitHidden(HiddenTree the node being visited node, P a parameter value p) Visits a `HiddenTree` node.
public R	Returns: a result value visitIdentifier(IdentifierTree the node being visited node, P a parameter value p) Visits an `IdentifierTree` node.
public default R	Returns: a result value visitIndex(IndexTree the node being visited node, P a parameter value p) Visits an `IndexTree` node.
public R	Returns: a result value visitInheritDoc(InheritDocTree the node being visited node, P a parameter value p) Visits an `InheritDocTree` node.
public R	Returns: a result value visitLink(LinkTree the node being visited node, P a parameter value p) Visits a `LinkTree` node.
public R	Returns: a result value visitLiteral(LiteralTree the node being visited node, P a parameter value p) Visits an `LiteralTree` node.
public R	Returns: a result value visitOther(DocTree the node being visited node, P a parameter value p) Visits an unknown type of `DocTree` node.
public R	Returns: a result value visitParam(ParamTree the node being visited node, P a parameter value p) Visits a `ParamTree` node.
public default R	Returns: a result value visitProvides(ProvidesTree the node being visited node, P a parameter value p) Visits a `ProvidesTree` node.
public R	Returns: a result value visitReference(ReferenceTree the node being visited node, P a parameter value p) Visits a `ReferenceTree` node.
public R	Returns: a result value visitReturn(ReturnTree the node being visited node, P a parameter value p) Visits a `ReturnTree` node.
public R	Returns: a result value visitSee(SeeTree the node being visited node, P a parameter value p) Visits a `SeeTree` node.
public R	Returns: a result value visitSerial(SerialTree the node being visited node, P a parameter value p) Visits a `SerialTree` node.
public R	Returns: a result value visitSerialData(SerialDataTree the node being visited node, P a parameter value p) Visits a `SerialDataTree` node.
public R	Returns: a result value visitSerialField(SerialFieldTree the node being visited node, P a parameter value p) Visits a `SerialFieldTree` node.
public R	Returns: a result value visitSince(SinceTree the node being visited node, P a parameter value p) Visits a `SinceTree` node.
public default R	Returns: a result value visitSnippet(SnippetTree the node being visited node, P a parameter value p) Visits a `SnippetTree` node.
public default R	Returns: a result value visitSpec(SpecTree the node being visited node, P a parameter value p) Visits a `SpecTree` node.
public R	Returns: a result value visitStartElement(StartElementTree the node being visited node, P a parameter value p) Visits a `StartElementTree` node.
public default R	Returns: a result value visitSummary(SummaryTree the node being visited node, P a parameter value p) Visits a `SummaryTree` node.
public default R	Returns: a result value visitSystemProperty(SystemPropertyTree the node being visited node, P a parameter value p) Visits a `SystemPropertyTree` node.
public R	Returns: a result value visitText(TextTree the node being visited node, P a parameter value p) Visits a `TextTree` node.
public R	Returns: a result value visitThrows(ThrowsTree the node being visited node, P a parameter value p) Visits a `ThrowsTree` node.
public R	Returns: a result value visitUnknownBlockTag(UnknownBlockTagTree the node being visited node, P a parameter value p) Visits an `UnknownBlockTagTree` node.
public R	Returns: a result value visitUnknownInlineTag(UnknownInlineTagTree the node being visited node, P a parameter value p) Visits an `UnknownInlineTagTree` node.
public default R	Returns: a result value visitUses(UsesTree the node being visited node, P a parameter value p) Visits a `UsesTree` node.
public R	Returns: a result value visitValue(ValueTree the node being visited node, P a parameter value p) Visits a `ValueTree` node.
public R	Returns: a result value visitVersion(VersionTree the node being visited node, P a parameter value p) Visits a `VersionTree` node.

Method Detail

visitAttribute back to summary

visitAttribute	back to summary
public R visitAttribute(AttributeTree node, P p) Visits an `AttributeTree` node. Parameters node:AttributeTree the node being visited p:P a parameter value Returns:R a result value

public R visitAttribute(AttributeTree node, P p)

Visits an AttributeTree node.

Parameters

node:AttributeTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitAuthor back to summary

visitAuthor	back to summary
public R visitAuthor(AuthorTree node, P p) Visits an `AuthorTree` node. Parameters node:AuthorTree the node being visited p:P a parameter value Returns:R a result value

public R visitAuthor(AuthorTree node, P p)

Visits an AuthorTree node.

Parameters

node:AuthorTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitComment back to summary

visitComment	back to summary
public R visitComment(CommentTree node, P p) Visits a `CommentTree` node. Parameters node:CommentTree the node being visited p:P a parameter value Returns:R a result value

public R visitComment(CommentTree node, P p)

Visits a CommentTree node.

Parameters

node:CommentTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitDeprecated back to summary

visitDeprecated	back to summary
public R visitDeprecated(DeprecatedTree node, P p) Visits a `DeprecatedTree` node. Parameters node:DeprecatedTree the node being visited p:P a parameter value Returns:R a result value

public R visitDeprecated(DeprecatedTree node, P p)

Visits a DeprecatedTree node.

Parameters

node:DeprecatedTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitDocComment back to summary

visitDocComment	back to summary
public R visitDocComment(DocCommentTree node, P p) Visits a `DocCommentTree` node. Parameters node:DocCommentTree the node being visited p:P a parameter value Returns:R a result value

public R visitDocComment(DocCommentTree node, P p)

Visits a DocCommentTree node.

Parameters

node:DocCommentTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitDocRoot back to summary

visitDocRoot	back to summary
public R visitDocRoot(DocRootTree node, P p) Visits a `DocRootTree` node. Parameters node:DocRootTree the node being visited p:P a parameter value Returns:R a result value

public R visitDocRoot(DocRootTree node, P p)

Visits a DocRootTree node.

Parameters

node:DocRootTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitDocType back to summary

visitDocType	back to summary
public default R visitDocType(DocTypeTree node, P p) Visits a `DocTypeTree` node. Implementation Specification Visits the provided `DocTypeTree` node by calling `visitOther(node, p)`. Parameters node:DocTypeTree the node being visited p:P a parameter value Returns:R a result value Since 10

public default R visitDocType(DocTypeTree node, P p)

Visits a DocTypeTree node.

Implementation Specification

Visits the provided DocTypeTree node by calling visitOther(node, p).

Parameters

node:DocTypeTree: the node being visited
p:P: a parameter value

Returns:R

a result value

Since

visitEndElement back to summary

visitEndElement	back to summary
public R visitEndElement(EndElementTree node, P p) Visits an `EndElementTree` node. Parameters node:EndElementTree the node being visited p:P a parameter value Returns:R a result value

public R visitEndElement(EndElementTree node, P p)

Visits an EndElementTree node.

Parameters

node:EndElementTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitEntity back to summary

visitEntity	back to summary
public R visitEntity(EntityTree node, P p) Visits an `EntityTree` node. Parameters node:EntityTree the node being visited p:P a parameter value Returns:R a result value

public R visitEntity(EntityTree node, P p)

Visits an EntityTree node.

Parameters

node:EntityTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitErroneous back to summary

visitErroneous	back to summary
public R visitErroneous(ErroneousTree node, P p) Visits an `ErroneousTree` node. Parameters node:ErroneousTree the node being visited p:P a parameter value Returns:R a result value

public R visitErroneous(ErroneousTree node, P p)

Visits an ErroneousTree node.

Parameters

node:ErroneousTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitEscape back to summary

visitEscape	back to summary
public default R visitEscape(EscapeTree node, P p) Visits an `EscapeTree` node. Implementation Specification Visits the provided `EscapeTree` node by calling `visitOther(node, p)`. Parameters node:EscapeTree the node being visited p:P a parameter value Returns:R a result value Since 21

public default R visitEscape(EscapeTree node, P p)

Visits an EscapeTree node.

Implementation Specification

Visits the provided EscapeTree node by calling visitOther(node, p).

Parameters

node:EscapeTree: the node being visited
p:P: a parameter value

Returns:R

a result value

Since

visitHidden back to summary

visitHidden	back to summary
public default R visitHidden(HiddenTree node, P p) Visits a `HiddenTree` node. Implementation Specification Visits the provided `HiddenTree` node by calling `visitOther(node, p)`. Parameters node:HiddenTree the node being visited p:P a parameter value Returns:R a result value Since 9

public default R visitHidden(HiddenTree node, P p)

Visits a HiddenTree node.

Implementation Specification

Visits the provided HiddenTree node by calling visitOther(node, p).

Parameters

node:HiddenTree: the node being visited
p:P: a parameter value

Returns:R

a result value

Since

visitIdentifier back to summary

visitIdentifier	back to summary
public R visitIdentifier(IdentifierTree node, P p) Visits an `IdentifierTree` node. Parameters node:IdentifierTree the node being visited p:P a parameter value Returns:R a result value

public R visitIdentifier(IdentifierTree node, P p)

Visits an IdentifierTree node.

Parameters

node:IdentifierTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitIndex back to summary

visitIndex	back to summary
public default R visitIndex(IndexTree node, P p) Visits an `IndexTree` node. Implementation Specification Visits the provided `IndexTree` node by calling `visitOther(node, p)`. Parameters node:IndexTree the node being visited p:P a parameter value Returns:R a result value Since 9

public default R visitIndex(IndexTree node, P p)

Visits an IndexTree node.

Implementation Specification

Visits the provided IndexTree node by calling visitOther(node, p).

Parameters

node:IndexTree: the node being visited
p:P: a parameter value

Returns:R

a result value

Since

visitInheritDoc back to summary

visitInheritDoc	back to summary
public R visitInheritDoc(InheritDocTree node, P p) Visits an `InheritDocTree` node. Parameters node:InheritDocTree the node being visited p:P a parameter value Returns:R a result value

public R visitInheritDoc(InheritDocTree node, P p)

Visits an InheritDocTree node.

Parameters

node:InheritDocTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitLink back to summary

visitLink	back to summary
public R visitLink(LinkTree node, P p) Visits a `LinkTree` node. Parameters node:LinkTree the node being visited p:P a parameter value Returns:R a result value

public R visitLink(LinkTree node, P p)

Visits a LinkTree node.

Parameters

node:LinkTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitLiteral back to summary

visitLiteral	back to summary
public R visitLiteral(LiteralTree node, P p) Visits an `LiteralTree` node. Parameters node:LiteralTree the node being visited p:P a parameter value Returns:R a result value

public R visitLiteral(LiteralTree node, P p)

Visits an LiteralTree node.

Parameters

node:LiteralTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitOther back to summary

visitOther	back to summary
public R visitOther(DocTree node, P p) Visits an unknown type of `DocTree` node. This can occur if the set of tags evolves and new kinds of nodes are added to the `DocTree` hierarchy. Parameters node:DocTree the node being visited p:P a parameter value Returns:R a result value

public R visitOther(DocTree node, P p)

Visits an unknown type of DocTree node. This can occur if the set of tags evolves and new kinds of nodes are added to the DocTree hierarchy.

Parameters

node:DocTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitParam back to summary

visitParam	back to summary
public R visitParam(ParamTree node, P p) Visits a `ParamTree` node. Parameters node:ParamTree the node being visited p:P a parameter value Returns:R a result value

public R visitParam(ParamTree node, P p)

Visits a ParamTree node.

Parameters

node:ParamTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitProvides back to summary

visitProvides	back to summary
public default R visitProvides(ProvidesTree node, P p) Visits a `ProvidesTree` node. Implementation Specification Visits the provided `ProvidesTree` node by calling `visitOther(node, p)`. Parameters node:ProvidesTree the node being visited p:P a parameter value Returns:R a result value Since 9

public default R visitProvides(ProvidesTree node, P p)

Visits a ProvidesTree node.

Implementation Specification

Visits the provided ProvidesTree node by calling visitOther(node, p).

Parameters

node:ProvidesTree: the node being visited
p:P: a parameter value

Returns:R

a result value

Since

visitReference back to summary

visitReference	back to summary
public R visitReference(ReferenceTree node, P p) Visits a `ReferenceTree` node. Parameters node:ReferenceTree the node being visited p:P a parameter value Returns:R a result value

public R visitReference(ReferenceTree node, P p)

Visits a ReferenceTree node.

Parameters

node:ReferenceTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitReturn back to summary

visitReturn	back to summary
public R visitReturn(ReturnTree node, P p) Visits a `ReturnTree` node. Parameters node:ReturnTree the node being visited p:P a parameter value Returns:R a result value

public R visitReturn(ReturnTree node, P p)

Visits a ReturnTree node.

Parameters

node:ReturnTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitSee back to summary

visitSee	back to summary
public R visitSee(SeeTree node, P p) Visits a `SeeTree` node. Parameters node:SeeTree the node being visited p:P a parameter value Returns:R a result value

public R visitSee(SeeTree node, P p)

Visits a SeeTree node.

Parameters

node:SeeTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitSerial back to summary

visitSerial	back to summary
public R visitSerial(SerialTree node, P p) Visits a `SerialTree` node. Parameters node:SerialTree the node being visited p:P a parameter value Returns:R a result value

public R visitSerial(SerialTree node, P p)

Visits a SerialTree node.

Parameters

node:SerialTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitSerialData back to summary

visitSerialData	back to summary
public R visitSerialData(SerialDataTree node, P p) Visits a `SerialDataTree` node. Parameters node:SerialDataTree the node being visited p:P a parameter value Returns:R a result value

public R visitSerialData(SerialDataTree node, P p)

Visits a SerialDataTree node.

Parameters

node:SerialDataTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitSerialField back to summary

visitSerialField	back to summary
public R visitSerialField(SerialFieldTree node, P p) Visits a `SerialFieldTree` node. Parameters node:SerialFieldTree the node being visited p:P a parameter value Returns:R a result value

public R visitSerialField(SerialFieldTree node, P p)

Visits a SerialFieldTree node.

Parameters

node:SerialFieldTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitSince back to summary

visitSince	back to summary
public R visitSince(SinceTree node, P p) Visits a `SinceTree` node. Parameters node:SinceTree the node being visited p:P a parameter value Returns:R a result value

public R visitSince(SinceTree node, P p)

Visits a SinceTree node.

Parameters

node:SinceTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitSnippet back to summary

visitSnippet	back to summary
public default R visitSnippet(SnippetTree node, P p) Visits a `SnippetTree` node. Implementation Specification Visits the provided `SnippetTree` node by calling `visitOther(node, p)`. Parameters node:SnippetTree the node being visited p:P a parameter value Returns:R a result value Since 18

public default R visitSnippet(SnippetTree node, P p)

Visits a SnippetTree node.

Implementation Specification

Visits the provided SnippetTree node by calling visitOther(node, p).

Parameters

node:SnippetTree: the node being visited
p:P: a parameter value

Returns:R

a result value

Since

visitSpec back to summary

visitSpec	back to summary
public default R visitSpec(SpecTree node, P p) Visits a `SpecTree` node. Implementation Specification Visits the provided `SpecTree` node by calling `visitOther(node, p)`. Parameters node:SpecTree the node being visited p:P a parameter value Returns:R a result value Since 20

public default R visitSpec(SpecTree node, P p)

Visits a SpecTree node.

Implementation Specification

Visits the provided SpecTree node by calling visitOther(node, p).

Parameters

node:SpecTree: the node being visited
p:P: a parameter value

Returns:R

a result value

Since

visitStartElement back to summary

visitStartElement	back to summary
public R visitStartElement(StartElementTree node, P p) Visits a `StartElementTree` node. Parameters node:StartElementTree the node being visited p:P a parameter value Returns:R a result value

public R visitStartElement(StartElementTree node, P p)

Visits a StartElementTree node.

Parameters

node:StartElementTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitSummary back to summary

visitSummary	back to summary
public default R visitSummary(SummaryTree node, P p) Visits a `SummaryTree` node. Implementation Specification Visits the provided `SummaryTree` node by calling `visitOther(node, p)`. Parameters node:SummaryTree the node being visited p:P a parameter value Returns:R a result value Since 10

public default R visitSummary(SummaryTree node, P p)

Visits a SummaryTree node.

Implementation Specification

Visits the provided SummaryTree node by calling visitOther(node, p).

Parameters

node:SummaryTree: the node being visited
p:P: a parameter value

Returns:R

a result value

Since

visitSystemProperty back to summary

visitSystemProperty	back to summary
public default R visitSystemProperty(SystemPropertyTree node, P p) Visits a `SystemPropertyTree` node. Implementation Specification Visits the provided `SystemPropertyTree` node by calling `visitOther(node, p)`. Parameters node:SystemPropertyTree the node being visited p:P a parameter value Returns:R a result value Since 12

public default R visitSystemProperty(SystemPropertyTree node, P p)

Visits a SystemPropertyTree node.

Implementation Specification

Visits the provided SystemPropertyTree node by calling visitOther(node, p).

Parameters

node:SystemPropertyTree: the node being visited
p:P: a parameter value

Returns:R

a result value

Since

visitText back to summary

visitText	back to summary
public R visitText(TextTree node, P p) Visits a `TextTree` node. Parameters node:TextTree the node being visited p:P a parameter value Returns:R a result value

public R visitText(TextTree node, P p)

Visits a TextTree node.

Parameters

node:TextTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitThrows back to summary

visitThrows	back to summary
public R visitThrows(ThrowsTree node, P p) Visits a `ThrowsTree` node. Parameters node:ThrowsTree the node being visited p:P a parameter value Returns:R a result value

public R visitThrows(ThrowsTree node, P p)

Visits a ThrowsTree node.

Parameters

node:ThrowsTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitUnknownBlockTag back to summary

visitUnknownBlockTag	back to summary
public R visitUnknownBlockTag(UnknownBlockTagTree node, P p) Visits an `UnknownBlockTagTree` node. Parameters node:UnknownBlockTagTree the node being visited p:P a parameter value Returns:R a result value

public R visitUnknownBlockTag(UnknownBlockTagTree node, P p)

Visits an UnknownBlockTagTree node.

Parameters

node:UnknownBlockTagTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitUnknownInlineTag back to summary

visitUnknownInlineTag	back to summary
public R visitUnknownInlineTag(UnknownInlineTagTree node, P p) Visits an `UnknownInlineTagTree` node. Parameters node:UnknownInlineTagTree the node being visited p:P a parameter value Returns:R a result value

public R visitUnknownInlineTag(UnknownInlineTagTree node, P p)

Visits an UnknownInlineTagTree node.

Parameters

node:UnknownInlineTagTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitUses back to summary

visitUses	back to summary
public default R visitUses(UsesTree node, P p) Visits a `UsesTree` node. Implementation Specification Visits a `UsesTree` node by calling `visitOther(node, p)`. Parameters node:UsesTree the node being visited p:P a parameter value Returns:R a result value Since 9

public default R visitUses(UsesTree node, P p)

Visits a UsesTree node.

Implementation Specification

Visits a UsesTree node by calling visitOther(node, p).

Parameters

node:UsesTree: the node being visited
p:P: a parameter value

Returns:R

a result value

Since

visitValue back to summary

visitValue	back to summary
public R visitValue(ValueTree node, P p) Visits a `ValueTree` node. Parameters node:ValueTree the node being visited p:P a parameter value Returns:R a result value

public R visitValue(ValueTree node, P p)

Visits a ValueTree node.

Parameters

node:ValueTree: the node being visited
p:P: a parameter value

Returns:R

a result value

visitVersion back to summary

visitVersion	back to summary
public R visitVersion(VersionTree node, P p) Visits a `VersionTree` node. Parameters node:VersionTree the node being visited p:P a parameter value Returns:R a result value

public R visitVersion(VersionTree node, P p)

Visits a VersionTree node.

Parameters

node:VersionTree: the node being visited
p:P: a parameter value

Returns:R

a result value

public Interface DocTreeVisitor<R, P>

Method Summary

Method Detail