Class JavadocDetailNodeParser

java.lang.Object

com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser

public class JavadocDetailNodeParser
extends Object

Used for parsing Javadoc comment as DetailNode tree.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	JavadocDetailNodeParser.DescriptiveErrorListener	Custom error listener for JavadocParser that prints user readable errors.
static class	JavadocDetailNodeParser.ParseErrorMessage	Contains information about parse error message.
static class	JavadocDetailNodeParser.ParseStatus	Contains result of parsing javadoc comment: DetailNode tree and parse error message.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	JAVADOC_START	Symbols with which javadoc starts.
static final String	MSG_JAVADOC_PARSE_RULE_ERROR	Parse error while rule recognition.
static final String	MSG_UNCLOSED_HTML_TAG	Message property key for the Unclosed HTML message.

Constructor Summary

Constructors

Constructor	Description
JavadocDetailNodeParser()

Method Summary

Modifier and Type	Method	Description
JavadocDetailNodeParser.ParseStatus	parseJavadocComment(DetailAST javadocCommentAst)	Parses the given Javadoc comment AST into a JavadocDetailNodeParser.ParseStatus object.

Methods inherited from class Object

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

Field Details

MSG_JAVADOC_PARSE_RULE_ERROR

public static final String MSG_JAVADOC_PARSE_RULE_ERROR

Parse error while rule recognition.

See Also:

• Constant Field Values

MSG_UNCLOSED_HTML_TAG

public static final String MSG_UNCLOSED_HTML_TAG

Message property key for the Unclosed HTML message.

See Also:

• Constant Field Values

JAVADOC_START

private static final String JAVADOC_START

Symbols with which javadoc starts.

See Also:

• Constant Field Values

Constructor Details

JavadocDetailNodeParser

public JavadocDetailNodeParser()

Method Details

parseJavadocComment

public JavadocDetailNodeParser.ParseStatus parseJavadocComment(DetailAST javadocCommentAst)

Parses the given Javadoc comment AST into a JavadocDetailNodeParser.ParseStatus object.

This method extracts the raw Javadoc comment text from the supplied DetailAST, creates a new lexer and parser for the Javadoc grammar, and attempts to parse it into an AST of DetailNodes. The parser uses PredictionMode.SLL for faster performance and stops parsing on the first error encountered by using CheckstyleParserErrorStrategy.

Parameters:

javadocCommentAst - the DetailAST node representing the Javadoc comment in the source file

Returns:

a JavadocDetailNodeParser.ParseStatus containing the root of the parsed Javadoc tree (if successful), the first non-tight HTML tag (if any), and the error message (if parsing failed)