Class JavadocCommentsAstVisitor

java.lang.Object

org.antlr.v4.runtime.tree.AbstractParseTreeVisitor<JavadocNodeImpl>

com.puppycrawl.tools.checkstyle.grammar.javadoc.JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

com.puppycrawl.tools.checkstyle.JavadocCommentsAstVisitor

All Implemented Interfaces:

JavadocCommentsParserVisitor<JavadocNodeImpl>, org.antlr.v4.runtime.tree.ParseTreeVisitor<JavadocNodeImpl>

public class JavadocCommentsAstVisitor
extends JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Visitor class used to build Checkstyle's Javadoc AST from the parse tree produced by JavadocCommentsParser. Each overridden visit... method visits children of a parse tree node (subrules) or creates terminal nodes (tokens), and returns a JavadocNodeImpl subtree as the result.

The order of visit... methods in JavaAstVisitor.java and production rules in JavaLanguageParser.g4 should be consistent to ease maintenance.

See Also:

• JavadocCommentsLexer
• JavadocCommentsParser
• JavadocNodeImpl
• JavaAstVisitor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	JavadocCommentsAstVisitor.TextAccumulator	A small utility to accumulate consecutive TEXT tokens into one node, preserving the starting token for accurate location metadata.

Field Summary

Fields

Modifier and Type	Field	Description
private final JavadocCommentsAstVisitor.TextAccumulator	accumulator	Accumulator for consecutive TEXT tokens.
private final int	blockCommentLineNumber	Line number of the Block comment AST that is being parsed.
private DetailNode	firstNonTightHtmlTag	The first non-tight HTML tag encountered in the Javadoc comment, if any.
private static final Set<Integer>	JAVADOC_TAG_TYPES	All Javadoc tag token types.
private final int	javadocColumnNumber	Javadoc Ident.
private final Set<Integer>	processedTokenIndices	A set of token indices used to track which tokens have already had their hidden tokens added to the AST.
private final org.antlr.v4.runtime.BufferedTokenStream	tokens	Token stream to check for hidden tokens.

Constructor Summary

Constructors

Constructor	Description
JavadocCommentsAstVisitor(org.antlr.v4.runtime.CommonTokenStream tokens, int blockCommentLineNumber, int javadocColumnNumber)	Constructs a JavaAstVisitor with given token stream, line number, and column number.

Method Summary

Modifier and Type	Method	Description
private void	addHiddenTokensToTheLeft(org.antlr.v4.runtime.Token token, JavadocNodeImpl parent)	Adds hidden tokens to the left of the given token to the parent node.
private JavadocNodeImpl	buildImaginaryNode(int tokenType, org.antlr.v4.runtime.ParserRuleContext ctx)	Creates an imaginary JavadocNodeImpl of the given token type and processes all children of the given ParserRuleContext.
private JavadocNodeImpl	create(org.antlr.v4.runtime.Token token)	Creates a JavadocNodeImpl from the given token.
private JavadocNodeImpl	createImaginary(int tokenType)	Create a JavadocNodeImpl from a given token and token type.
private JavadocNodeImpl	flattenedTree(org.antlr.v4.runtime.ParserRuleContext ctx)	Builds the AST for a particular node, then returns a "flattened" tree of siblings.
DetailNode	getFirstNonTightHtmlTag()	Returns the first non-tight HTML tag encountered in the Javadoc comment, if any.
private static boolean	isJavadocTag(int type)	Checks if the given token type is a Javadoc tag.
private static boolean	isTextToken(org.antlr.v4.runtime.Token token)	Checks whether a token is a Javadoc text token.
private void	processChildren(JavadocNodeImpl parent, List<? extends org.antlr.v4.runtime.tree.ParseTree> children)	Adds all the children from the given ParseTree or ParserRuleContext list to the parent JavadocNodeImpl.
JavadocNodeImpl	visitAuthorTag(JavadocCommentsParser.AuthorTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.authorTag().
JavadocNodeImpl	visitBlockTag(JavadocCommentsParser.BlockTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.blockTag().
JavadocNodeImpl	visitCodeInlineTag(JavadocCommentsParser.CodeInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.codeInlineTag().
JavadocNodeImpl	visitCustomBlockTag(JavadocCommentsParser.CustomBlockTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.customBlockTag().
JavadocNodeImpl	visitCustomInlineTag(JavadocCommentsParser.CustomInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.customInlineTag().
JavadocNodeImpl	visitDeprecatedTag(JavadocCommentsParser.DeprecatedTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.deprecatedTag().
JavadocNodeImpl	visitDescription(JavadocCommentsParser.DescriptionContext ctx)	Visit a parse tree produced by JavadocCommentsParser.description().
JavadocNodeImpl	visitExceptionTag(JavadocCommentsParser.ExceptionTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.exceptionTag().
JavadocNodeImpl	visitHiddenTag(JavadocCommentsParser.HiddenTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.hiddenTag().
JavadocNodeImpl	visitHtmlAttribute(JavadocCommentsParser.HtmlAttributeContext ctx)	Visit a parse tree produced by JavadocCommentsParser.htmlAttribute().
JavadocNodeImpl	visitHtmlComment(JavadocCommentsParser.HtmlCommentContext ctx)	Visit a parse tree produced by JavadocCommentsParser.htmlComment().
JavadocNodeImpl	visitHtmlCommentContent(JavadocCommentsParser.HtmlCommentContentContext ctx)	Visit a parse tree produced by JavadocCommentsParser.htmlCommentContent().
JavadocNodeImpl	visitHtmlContent(JavadocCommentsParser.HtmlContentContext ctx)	Visit a parse tree produced by JavadocCommentsParser.htmlContent().
JavadocNodeImpl	visitHtmlElement(JavadocCommentsParser.HtmlElementContext ctx)	Visit a parse tree produced by JavadocCommentsParser.htmlElement().
JavadocNodeImpl	visitHtmlTagEnd(JavadocCommentsParser.HtmlTagEndContext ctx)	Visit a parse tree produced by JavadocCommentsParser.htmlTagEnd().
JavadocNodeImpl	visitHtmlTagStart(JavadocCommentsParser.HtmlTagStartContext ctx)	Visit a parse tree produced by JavadocCommentsParser.htmlTagStart().
JavadocNodeImpl	visitIndexInlineTag(JavadocCommentsParser.IndexInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.indexInlineTag().
JavadocNodeImpl	visitInheritDocInlineTag(JavadocCommentsParser.InheritDocInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.inheritDocInlineTag().
JavadocNodeImpl	visitInlineTag(JavadocCommentsParser.InlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.inlineTag().
JavadocNodeImpl	visitInlineTagContent(JavadocCommentsParser.InlineTagContentContext ctx)	Visit a parse tree produced by JavadocCommentsParser.inlineTagContent().
JavadocNodeImpl	visitJavadoc(JavadocCommentsParser.JavadocContext ctx)	Visit a parse tree produced by JavadocCommentsParser.javadoc().
JavadocNodeImpl	visitLinkInlineTag(JavadocCommentsParser.LinkInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.linkInlineTag().
JavadocNodeImpl	visitLinkPlainInlineTag(JavadocCommentsParser.LinkPlainInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.linkPlainInlineTag().
JavadocNodeImpl	visitLiteralInlineTag(JavadocCommentsParser.LiteralInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.literalInlineTag().
JavadocNodeImpl	visitMainDescription(JavadocCommentsParser.MainDescriptionContext ctx)	Visit a parse tree produced by JavadocCommentsParser.mainDescription().
JavadocNodeImpl	visitMemberReference(JavadocCommentsParser.MemberReferenceContext ctx)	Visit a parse tree produced by JavadocCommentsParser.memberReference().
JavadocNodeImpl	visitNonTightElement(JavadocCommentsParser.NonTightElementContext ctx)	Visit a parse tree produced by JavadocCommentsParser.nonTightElement().
JavadocNodeImpl	visitNonTightHtmlContent(JavadocCommentsParser.NonTightHtmlContentContext ctx)	Visit a parse tree produced by JavadocCommentsParser.nonTightHtmlContent().
JavadocNodeImpl	visitParameterTag(JavadocCommentsParser.ParameterTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.parameterTag().
JavadocNodeImpl	visitParameterTypeList(JavadocCommentsParser.ParameterTypeListContext ctx)	Visit a parse tree produced by JavadocCommentsParser.parameterTypeList().
JavadocNodeImpl	visitProvidesTag(JavadocCommentsParser.ProvidesTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.providesTag().
JavadocNodeImpl	visitQualifiedName(JavadocCommentsParser.QualifiedNameContext ctx)	Visit a parse tree produced by JavadocCommentsParser.qualifiedName().
JavadocNodeImpl	visitReference(JavadocCommentsParser.ReferenceContext ctx)	Visit a parse tree produced by JavadocCommentsParser.reference().
JavadocNodeImpl	visitReturnInlineTag(JavadocCommentsParser.ReturnInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.returnInlineTag().
JavadocNodeImpl	visitReturnTag(JavadocCommentsParser.ReturnTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.returnTag().
JavadocNodeImpl	visitSeeTag(JavadocCommentsParser.SeeTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.seeTag().
JavadocNodeImpl	visitSelfClosingElement(JavadocCommentsParser.SelfClosingElementContext ctx)	Visit a parse tree produced by JavadocCommentsParser.selfClosingElement().
JavadocNodeImpl	visitSerialDataTag(JavadocCommentsParser.SerialDataTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.serialDataTag().
JavadocNodeImpl	visitSerialFieldTag(JavadocCommentsParser.SerialFieldTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.serialFieldTag().
JavadocNodeImpl	visitSerialTag(JavadocCommentsParser.SerialTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.serialTag().
JavadocNodeImpl	visitSinceTag(JavadocCommentsParser.SinceTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.sinceTag().
JavadocNodeImpl	visitSnippetAttribute(JavadocCommentsParser.SnippetAttributeContext ctx)	Visit a parse tree produced by JavadocCommentsParser.snippetAttribute().
JavadocNodeImpl	visitSnippetBody(JavadocCommentsParser.SnippetBodyContext ctx)	Visit a parse tree produced by JavadocCommentsParser.snippetBody().
JavadocNodeImpl	visitSnippetInlineTag(JavadocCommentsParser.SnippetInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.snippetInlineTag().
JavadocNodeImpl	visitSummaryInlineTag(JavadocCommentsParser.SummaryInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.summaryInlineTag().
JavadocNodeImpl	visitSystemPropertyInlineTag(JavadocCommentsParser.SystemPropertyInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.systemPropertyInlineTag().
JavadocNodeImpl	visitThrowsTag(JavadocCommentsParser.ThrowsTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.throwsTag().
JavadocNodeImpl	visitTightElement(JavadocCommentsParser.TightElementContext ctx)	Visit a parse tree produced by JavadocCommentsParser.tightElement().
JavadocNodeImpl	visitTypeArgument(JavadocCommentsParser.TypeArgumentContext ctx)	Visit a parse tree produced by JavadocCommentsParser.typeArgument().
JavadocNodeImpl	visitTypeArguments(JavadocCommentsParser.TypeArgumentsContext ctx)	Visit a parse tree produced by JavadocCommentsParser.typeArguments().
JavadocNodeImpl	visitTypeName(JavadocCommentsParser.TypeNameContext ctx)	Visit a parse tree produced by JavadocCommentsParser.typeName().
JavadocNodeImpl	visitUsesTag(JavadocCommentsParser.UsesTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.usesTag().
JavadocNodeImpl	visitValueInlineTag(JavadocCommentsParser.ValueInlineTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.valueInlineTag().
JavadocNodeImpl	visitVersionTag(JavadocCommentsParser.VersionTagContext ctx)	Visit a parse tree produced by JavadocCommentsParser.versionTag().
JavadocNodeImpl	visitVoidElement(JavadocCommentsParser.VoidElementContext ctx)	Visit a parse tree produced by JavadocCommentsParser.voidElement().

Methods inherited from class org.antlr.v4.runtime.tree.AbstractParseTreeVisitor

aggregateResult, defaultResult, shouldVisitNextChild, visit, visitChildren, visitErrorNode, visitTerminal

Methods inherited from class Object

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

Methods inherited from interface org.antlr.v4.runtime.tree.ParseTreeVisitor

visit, visitChildren, visitErrorNode, visitTerminal

Field Details

JAVADOC_TAG_TYPES

private static final Set<Integer> JAVADOC_TAG_TYPES

All Javadoc tag token types.

blockCommentLineNumber

private final int blockCommentLineNumber

Line number of the Block comment AST that is being parsed.

javadocColumnNumber

private final int javadocColumnNumber

Javadoc Ident.

tokens

private final org.antlr.v4.runtime.BufferedTokenStream tokens

Token stream to check for hidden tokens.

processedTokenIndices

private final Set<Integer> processedTokenIndices

A set of token indices used to track which tokens have already had their hidden tokens added to the AST.

accumulator

private final JavadocCommentsAstVisitor.TextAccumulator accumulator

Accumulator for consecutive TEXT tokens. This is used to merge multiple TEXT tokens into a single node.

firstNonTightHtmlTag

private DetailNode firstNonTightHtmlTag

The first non-tight HTML tag encountered in the Javadoc comment, if any.

Constructor Details

JavadocCommentsAstVisitor

public JavadocCommentsAstVisitor(org.antlr.v4.runtime.CommonTokenStream tokens,
 int blockCommentLineNumber,
 int javadocColumnNumber)

Constructs a JavaAstVisitor with given token stream, line number, and column number.

Parameters:

tokens - the token stream to check for hidden tokens

blockCommentLineNumber - the line number of the block comment being parsed

javadocColumnNumber - the column number of the javadoc indent

Method Details

visitJavadoc

public JavadocNodeImpl visitJavadoc(JavadocCommentsParser.JavadocContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.javadoc().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitJavadoc in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitJavadoc in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitMainDescription

public JavadocNodeImpl visitMainDescription(JavadocCommentsParser.MainDescriptionContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.mainDescription().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitMainDescription in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitMainDescription in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitBlockTag

public JavadocNodeImpl visitBlockTag(JavadocCommentsParser.BlockTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.blockTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitBlockTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitBlockTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitAuthorTag

public JavadocNodeImpl visitAuthorTag(JavadocCommentsParser.AuthorTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.authorTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitAuthorTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitAuthorTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitDeprecatedTag

public JavadocNodeImpl visitDeprecatedTag(JavadocCommentsParser.DeprecatedTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.deprecatedTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitDeprecatedTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitDeprecatedTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitReturnTag

public JavadocNodeImpl visitReturnTag(JavadocCommentsParser.ReturnTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.returnTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitReturnTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitReturnTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitParameterTag

public JavadocNodeImpl visitParameterTag(JavadocCommentsParser.ParameterTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.parameterTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitParameterTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitParameterTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitThrowsTag

public JavadocNodeImpl visitThrowsTag(JavadocCommentsParser.ThrowsTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.throwsTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitThrowsTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitThrowsTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitExceptionTag

public JavadocNodeImpl visitExceptionTag(JavadocCommentsParser.ExceptionTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.exceptionTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitExceptionTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitExceptionTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSinceTag

public JavadocNodeImpl visitSinceTag(JavadocCommentsParser.SinceTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.sinceTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitSinceTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitSinceTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitVersionTag

public JavadocNodeImpl visitVersionTag(JavadocCommentsParser.VersionTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.versionTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitVersionTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitVersionTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSeeTag

public JavadocNodeImpl visitSeeTag(JavadocCommentsParser.SeeTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.seeTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitSeeTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitSeeTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitHiddenTag

public JavadocNodeImpl visitHiddenTag(JavadocCommentsParser.HiddenTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.hiddenTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitHiddenTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitHiddenTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitUsesTag

public JavadocNodeImpl visitUsesTag(JavadocCommentsParser.UsesTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.usesTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitUsesTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitUsesTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitProvidesTag

public JavadocNodeImpl visitProvidesTag(JavadocCommentsParser.ProvidesTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.providesTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitProvidesTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitProvidesTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSerialTag

public JavadocNodeImpl visitSerialTag(JavadocCommentsParser.SerialTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.serialTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitSerialTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitSerialTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSerialDataTag

public JavadocNodeImpl visitSerialDataTag(JavadocCommentsParser.SerialDataTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.serialDataTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitSerialDataTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitSerialDataTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSerialFieldTag

public JavadocNodeImpl visitSerialFieldTag(JavadocCommentsParser.SerialFieldTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.serialFieldTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitSerialFieldTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitSerialFieldTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitCustomBlockTag

public JavadocNodeImpl visitCustomBlockTag(JavadocCommentsParser.CustomBlockTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.customBlockTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitCustomBlockTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitCustomBlockTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitInlineTag

public JavadocNodeImpl visitInlineTag(JavadocCommentsParser.InlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.inlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitInlineTagContent

public JavadocNodeImpl visitInlineTagContent(JavadocCommentsParser.InlineTagContentContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.inlineTagContent().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitInlineTagContent in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitInlineTagContent in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitCodeInlineTag

public JavadocNodeImpl visitCodeInlineTag(JavadocCommentsParser.CodeInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.codeInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitCodeInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitCodeInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitLinkPlainInlineTag

public JavadocNodeImpl visitLinkPlainInlineTag(JavadocCommentsParser.LinkPlainInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.linkPlainInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitLinkPlainInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitLinkPlainInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitLinkInlineTag

public JavadocNodeImpl visitLinkInlineTag(JavadocCommentsParser.LinkInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.linkInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitLinkInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitLinkInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitValueInlineTag

public JavadocNodeImpl visitValueInlineTag(JavadocCommentsParser.ValueInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.valueInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitValueInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitValueInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitInheritDocInlineTag

public JavadocNodeImpl visitInheritDocInlineTag(JavadocCommentsParser.InheritDocInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.inheritDocInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitInheritDocInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitInheritDocInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSummaryInlineTag

public JavadocNodeImpl visitSummaryInlineTag(JavadocCommentsParser.SummaryInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.summaryInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitSummaryInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitSummaryInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSystemPropertyInlineTag

public JavadocNodeImpl visitSystemPropertyInlineTag(JavadocCommentsParser.SystemPropertyInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.systemPropertyInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitSystemPropertyInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitSystemPropertyInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitIndexInlineTag

public JavadocNodeImpl visitIndexInlineTag(JavadocCommentsParser.IndexInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.indexInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitIndexInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitIndexInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitReturnInlineTag

public JavadocNodeImpl visitReturnInlineTag(JavadocCommentsParser.ReturnInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.returnInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitReturnInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitReturnInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitLiteralInlineTag

public JavadocNodeImpl visitLiteralInlineTag(JavadocCommentsParser.LiteralInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.literalInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitLiteralInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitLiteralInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSnippetInlineTag

public JavadocNodeImpl visitSnippetInlineTag(JavadocCommentsParser.SnippetInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.snippetInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitSnippetInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitSnippetInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitCustomInlineTag

public JavadocNodeImpl visitCustomInlineTag(JavadocCommentsParser.CustomInlineTagContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.customInlineTag().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitCustomInlineTag in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitCustomInlineTag in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitReference

public JavadocNodeImpl visitReference(JavadocCommentsParser.ReferenceContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.reference().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitReference in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitReference in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitTypeName

public JavadocNodeImpl visitTypeName(JavadocCommentsParser.TypeNameContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.typeName().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitTypeName in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitTypeName in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitQualifiedName

public JavadocNodeImpl visitQualifiedName(JavadocCommentsParser.QualifiedNameContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.qualifiedName().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitQualifiedName in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitQualifiedName in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitTypeArguments

public JavadocNodeImpl visitTypeArguments(JavadocCommentsParser.TypeArgumentsContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.typeArguments().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitTypeArguments in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitTypeArguments in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitTypeArgument

public JavadocNodeImpl visitTypeArgument(JavadocCommentsParser.TypeArgumentContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.typeArgument().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitTypeArgument in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitTypeArgument in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitMemberReference

public JavadocNodeImpl visitMemberReference(JavadocCommentsParser.MemberReferenceContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.memberReference().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitMemberReference in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitMemberReference in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitParameterTypeList

public JavadocNodeImpl visitParameterTypeList(JavadocCommentsParser.ParameterTypeListContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.parameterTypeList().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitParameterTypeList in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitParameterTypeList in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitDescription

public JavadocNodeImpl visitDescription(JavadocCommentsParser.DescriptionContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.description().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitDescription in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitDescription in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSnippetAttribute

public JavadocNodeImpl visitSnippetAttribute(JavadocCommentsParser.SnippetAttributeContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.snippetAttribute().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitSnippetAttribute in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitSnippetAttribute in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSnippetBody

public JavadocNodeImpl visitSnippetBody(JavadocCommentsParser.SnippetBodyContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.snippetBody().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitSnippetBody in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitSnippetBody in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitHtmlElement

public JavadocNodeImpl visitHtmlElement(JavadocCommentsParser.HtmlElementContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.htmlElement().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitHtmlElement in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitHtmlElement in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitVoidElement

public JavadocNodeImpl visitVoidElement(JavadocCommentsParser.VoidElementContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.voidElement().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitVoidElement in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitVoidElement in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitTightElement

public JavadocNodeImpl visitTightElement(JavadocCommentsParser.TightElementContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.tightElement().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitTightElement in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitTightElement in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitNonTightElement

public JavadocNodeImpl visitNonTightElement(JavadocCommentsParser.NonTightElementContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.nonTightElement().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitNonTightElement in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitNonTightElement in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitSelfClosingElement

public JavadocNodeImpl visitSelfClosingElement(JavadocCommentsParser.SelfClosingElementContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.selfClosingElement().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitSelfClosingElement in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitSelfClosingElement in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitHtmlTagStart

public JavadocNodeImpl visitHtmlTagStart(JavadocCommentsParser.HtmlTagStartContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.htmlTagStart().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitHtmlTagStart in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitHtmlTagStart in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitHtmlTagEnd

public JavadocNodeImpl visitHtmlTagEnd(JavadocCommentsParser.HtmlTagEndContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.htmlTagEnd().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitHtmlTagEnd in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitHtmlTagEnd in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitHtmlAttribute

public JavadocNodeImpl visitHtmlAttribute(JavadocCommentsParser.HtmlAttributeContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.htmlAttribute().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitHtmlAttribute in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitHtmlAttribute in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitHtmlContent

public JavadocNodeImpl visitHtmlContent(JavadocCommentsParser.HtmlContentContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.htmlContent().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitHtmlContent in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitHtmlContent in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitNonTightHtmlContent

public JavadocNodeImpl visitNonTightHtmlContent(JavadocCommentsParser.NonTightHtmlContentContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.nonTightHtmlContent().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitNonTightHtmlContent in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitNonTightHtmlContent in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitHtmlComment

public JavadocNodeImpl visitHtmlComment(JavadocCommentsParser.HtmlCommentContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.htmlComment().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitHtmlComment in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitHtmlComment in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

visitHtmlCommentContent

public JavadocNodeImpl visitHtmlCommentContent(JavadocCommentsParser.HtmlCommentContentContext ctx)

Description copied from class: JavadocCommentsParserBaseVisitor

Visit a parse tree produced by JavadocCommentsParser.htmlCommentContent().

The default implementation returns the result of calling AbstractParseTreeVisitor.visitChildren(RuleNode) on ctx.

Specified by:

visitHtmlCommentContent in interface JavadocCommentsParserVisitor<JavadocNodeImpl>

Overrides:

visitHtmlCommentContent in class JavadocCommentsParserBaseVisitor<JavadocNodeImpl>

Parameters:

ctx - the parse tree

Returns:

the visitor result

buildImaginaryNode

private JavadocNodeImpl buildImaginaryNode(int tokenType,
 org.antlr.v4.runtime.ParserRuleContext ctx)

Creates an imaginary JavadocNodeImpl of the given token type and processes all children of the given ParserRuleContext.

Parameters:

tokenType - the token type of this JavadocNodeImpl

ctx - the ParserRuleContext whose children are to be processed

Returns:

new JavadocNodeImpl of given type with processed children

flattenedTree

private JavadocNodeImpl flattenedTree(org.antlr.v4.runtime.ParserRuleContext ctx)

Builds the AST for a particular node, then returns a "flattened" tree of siblings.

Parameters:

ctx - the ParserRuleContext to base tree on

Returns:

flattened DetailAstImpl

processChildren

private void processChildren(JavadocNodeImpl parent,
 List<? extends org.antlr.v4.runtime.tree.ParseTree> children)

Adds all the children from the given ParseTree or ParserRuleContext list to the parent JavadocNodeImpl.

Parameters:

parent - the JavadocNodeImpl to add children to

children - the list of children to add

isTextToken

private static boolean isTextToken(org.antlr.v4.runtime.Token token)

Checks whether a token is a Javadoc text token.

Parameters:

token - the token to check

Returns:

true if the token is a text token, false otherwise

addHiddenTokensToTheLeft

private void addHiddenTokensToTheLeft(org.antlr.v4.runtime.Token token,
 JavadocNodeImpl parent)

Adds hidden tokens to the left of the given token to the parent node. Ensures text accumulation is flushed before adding hidden tokens. Hidden tokens are only added once per unique token index.

Parameters:

token - the token whose hidden tokens should be added

parent - the parent node to which hidden tokens are added

create

private JavadocNodeImpl create(org.antlr.v4.runtime.Token token)

Creates a JavadocNodeImpl from the given token.

Parameters:

token - the token to create the JavadocNodeImpl from

Returns:

a new JavadocNodeImpl initialized with the token

isJavadocTag

private static boolean isJavadocTag(int type)

Checks if the given token type is a Javadoc tag.

Parameters:

type - the token type to check

Returns:

true if the token type is a Javadoc tag, false otherwise

createImaginary

private JavadocNodeImpl createImaginary(int tokenType)

Create a JavadocNodeImpl from a given token and token type. This method should be used for imaginary nodes only, i.e. 'JAVADOC_INLINE_TAG -> JAVADOC_INLINE_TAG', where the text on the RHS matches the text on the LHS.

Parameters:

tokenType - the token type of this JavadocNodeImpl

Returns:

new JavadocNodeImpl of given type

getFirstNonTightHtmlTag

public DetailNode getFirstNonTightHtmlTag()

Returns the first non-tight HTML tag encountered in the Javadoc comment, if any.

Returns:

the first non-tight HTML tag, or null if none was found