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

Constructor Summary

Constructors

Constructor and Description
AbstractJavadocCheck()

Method Summary

Methods

Modifier and Type	Method and Description
void	beginJavadocTree(DetailNode aRootAst) Called before the starting to process a tree.
void	beginTree(DetailAST aRootAST) Called before the starting to process a tree.
void	finishJavadocTree(DetailNode aRootAst) Called after finished processing a tree.
void	finishTree(DetailAST aRootAST) Called after finished processing a tree.
int[]	getAcceptableTokens() Defined final to not allow JavadocChecks to change acceptable tokens.
protected DetailAST	getBlockCommentAst()
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.
int[]	getRequiredTokens() Defined final to not allow JavadocChecks to change required tokens.
boolean	isCommentNodesRequired() Defined final because all JavadocChecks require comment nodes.
void	leaveJavadocToken(DetailNode aAst) Called after all the child nodes have been process.
void	leaveToken(DetailAST aAST) Called after all the child nodes have been process.
void	visitJavadocToken(DetailNode aAst) Called to process a Javadoc token.
void	visitToken(DetailAST aBlockCommentAst) Called to process a token.

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

destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, 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

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 aRootAst)

Called before the starting to process a tree.

Parameters:

aRootAst - the root of the tree

finishJavadocTree

public void finishJavadocTree(DetailNode aRootAst)

Called after finished processing a tree.

Parameters:

aRootAst - the root of the tree

visitJavadocToken

public void visitJavadocToken(DetailNode aAst)

Called to process a Javadoc token.

Parameters:

aAst - the token to process

leaveJavadocToken

public void leaveJavadocToken(DetailNode aAst)

Called after all the child nodes have been process.

Parameters:

aAst - 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

getAcceptableTokens

public final int[] getAcceptableTokens()

Defined final to not allow JavadocChecks to change acceptable tokens.

Overrides:

getAcceptableTokens in class Check

Returns:

acceptable tokens

See Also:

TokenTypes

getRequiredTokens

public final int[] getRequiredTokens()

Defined final to not allow JavadocChecks to change required tokens.

Overrides:

getRequiredTokens in class Check

Returns:

required 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 aRootAST)

Description copied from class: Check

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

Overrides:

beginTree in class Check

Parameters:

aRootAST - the root of the tree

finishTree

public final void finishTree(DetailAST aRootAST)

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:

aRootAST - the root of the tree

leaveToken

public final void leaveToken(DetailAST aAST)

Description copied from class: Check

Called after all the child nodes have been process.

Overrides:

leaveToken in class Check

Parameters:

aAST - the token leaving

visitToken

public final void visitToken(DetailAST aBlockCommentAst)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

aBlockCommentAst - the token to process

getBlockCommentAst

protected DetailAST getBlockCommentAst()