com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocVariableCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class JavadocVariableCheck
extends AbstractCheck

Checks that a variable has Javadoc comment. Ignores serialVersionUID fields.

Field Summary

Fields

Modifier and Type	Field and Description
private Scope	excludeScope The visibility scope where Javadoc comments shouldn't be checked.
private java.util.regex.Pattern	ignoreNamePattern The pattern to ignore variable name.
static java.lang.String	MSG_JAVADOC_MISSING A key is pointing to the warning message text in "messages.properties" file.
private Scope	scope The scope to check.

Constructor Summary

Constructors

Constructor and Description
JavadocVariableCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
private boolean	isIgnored(DetailAST ast) Decides whether the variable name of an AST is in the ignore list.
void	setExcludeScope(Scope excludeScope) Set the excludeScope.
void	setIgnoreNamePattern(java.util.regex.Pattern pattern) Sets the variable names to ignore in the check.
void	setScope(Scope scope) Sets the scope to check.
private boolean	shouldCheck(DetailAST ast) Whether we should check this node.
void	visitToken(DetailAST ast) Called to process a token.

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

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

MSG_JAVADOC_MISSING

public static final java.lang.String MSG_JAVADOC_MISSING

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

scope

private Scope scope

The scope to check.

excludeScope

private Scope excludeScope

The visibility scope where Javadoc comments shouldn't be checked.

ignoreNamePattern

private java.util.regex.Pattern ignoreNamePattern

The pattern to ignore variable name.

Constructor Detail

JavadocVariableCheck

public JavadocVariableCheck()

Method Detail

setScope

public void setScope(Scope scope)

Sets the scope to check.

Parameters:

scope - a scope.

setExcludeScope

public void setExcludeScope(Scope excludeScope)

Set the excludeScope.

Parameters:

excludeScope - a scope.

setIgnoreNamePattern

public void setIgnoreNamePattern(java.util.regex.Pattern pattern)

Sets the variable names to ignore in the check.

Parameters:

pattern - a pattern.

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: AbstractCheck

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class AbstractCheck

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: AbstractCheck

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Specified by:

getAcceptableTokens in class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Specified by:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

isIgnored

private boolean isIgnored(DetailAST ast)

Decides whether the variable name of an AST is in the ignore list.

Parameters:

ast - the AST to check

Returns:

true if the variable name of ast is in the ignore list.

shouldCheck

private boolean shouldCheck(DetailAST ast)

Whether we should check this node.

Parameters:

ast - a given node.

Returns:

whether we should check a given node.