com.puppycrawl.tools.checkstyle.checks.javadoc

Class AbstractJavadocCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

All Implemented Interfaces:

Configurable, Contextualizable

Direct Known Subclasses:

AtclauseOrderCheck, JavadocParagraphCheck, JavadocTagContinuationIndentationCheck, NonEmptyAtclauseDescriptionCheck, SingleLineJavadocCheck, SummaryJavadocCheck

public abstract class AbstractJavadocCheck
extends Check

Base class for Checks that process Javadoc comments.

Author:

Baratali Izmailov

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARSE_ERROR_MESSAGE_KEY Error message key for common javadoc errors.
static String	UNRECOGNIZED_ANTLR_ERROR_MESSAGE_KEY Unrecognized error from antlr parser.

Constructor Summary

Constructors

Constructor and Description
AbstractJavadocCheck()

Method Summary

Modifier and Type	Method and Description
void	beginJavadocTree(DetailNode rootAst) Called before the starting to process a tree.
void	beginTree(DetailAST rootAST) Called before the starting to process a tree.
void	finishJavadocTree(DetailNode rootAst) Called after finished processing a tree.
void	finishTree(DetailAST rootAST) Called after finished processing a tree.
protected DetailAST	getBlockCommentAst() Getter for block comment in Java language syntax tree.
abstract int[]	getDefaultJavadocTokens() Returns the default token types a check is interested in.
int[]	getDefaultTokens() Defined final to not allow JavadocChecks to change default tokens.
boolean	isCommentNodesRequired() Defined final because all JavadocChecks require comment nodes.
void	leaveJavadocToken(DetailNode ast) Called after all the child nodes have been process.
abstract void	visitJavadocToken(DetailNode ast) Called to process a Javadoc token.
void	visitToken(DetailAST blockCommentNode) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

destroy, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

PARSE_ERROR_MESSAGE_KEY

public static final String PARSE_ERROR_MESSAGE_KEY

Error message key for common javadoc errors.

See Also:

Constant Field Values

UNRECOGNIZED_ANTLR_ERROR_MESSAGE_KEY

public static final String UNRECOGNIZED_ANTLR_ERROR_MESSAGE_KEY

Unrecognized error from antlr parser.

See Also:

Constant Field Values

Constructor Detail

AbstractJavadocCheck

public AbstractJavadocCheck()

Method Detail

getDefaultJavadocTokens

public abstract int[] getDefaultJavadocTokens()

Returns the default token types a check is interested in.

Returns:

the default token types

See Also:

JavadocTokenTypes

beginJavadocTree

public void beginJavadocTree(DetailNode rootAst)

Called before the starting to process a tree.

Parameters:

rootAst - the root of the tree

finishJavadocTree

public void finishJavadocTree(DetailNode rootAst)

Called after finished processing a tree.

Parameters:

rootAst - the root of the tree

visitJavadocToken

public abstract void visitJavadocToken(DetailNode ast)

Called to process a Javadoc token.

Parameters:

ast - the token to process

leaveJavadocToken

public void leaveJavadocToken(DetailNode ast)

Called after all the child nodes have been process.

Parameters:

ast - the token leaving

getDefaultTokens

public final int[] getDefaultTokens()

Defined final to not allow JavadocChecks to change default tokens.

Specified by:

getDefaultTokens in class Check

Returns:

default tokens

See Also:

TokenTypes

isCommentNodesRequired

public final boolean isCommentNodesRequired()

Defined final because all JavadocChecks require comment nodes.

Overrides:

isCommentNodesRequired in class Check

Returns:

true

beginTree

public final void beginTree(DetailAST rootAST)

Description copied from class: Check

Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.

Overrides:

beginTree in class Check

Parameters:

rootAST - the root of the tree

finishTree

public final void finishTree(DetailAST rootAST)

Description copied from class: Check

Called after finished processing a tree. Ideal place to report on information collected whilst processing a tree.

Overrides:

finishTree in class Check

Parameters:

rootAST - the root of the tree

visitToken

public final void visitToken(DetailAST blockCommentNode)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

blockCommentNode - the token to process

getBlockCommentAst

protected DetailAST getBlockCommentAst()

Getter for block comment in Java language syntax tree.

Returns:

A block comment in the syntax tree.