com.puppycrawl.tools.checkstyle.checks.coding

Class FinalLocalVariableCheck

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.coding.FinalLocalVariableCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class FinalLocalVariableCheck
extends Check

Ensures that local variables that never get their values changed, must be declared final.

An example of how to configure the check is:

 <module name="FinalLocalVariable">
     <property name="token" value="VARIABLE_DEF"/>
 </module>
 

By default, this Check skip final validation on Enhanced For-Loop

Option 'validateEnhancedForLoopVariable' could be used to make Check to validate even variable from Enhanced For Loop.

An example of how to configure the check so that it also validates enhanced For Loop Variable is:

 <module name="FinalLocalVariable">
     <property name="token" value="VARIABLE_DEF"/>
     <property name="validateEnhancedForLoopVariable" value="true"/>
 </module>
 

Example:

for (int number : myNumbers) { // violation System.out.println(number); }

Author:

k_gibbs, r_auckenthaler

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
FinalLocalVariableCheck()

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.
void	leaveToken(DetailAST ast) Called after all the child nodes have been process.
void	setValidateEnhancedForLoopVariable(boolean validateEnhancedForLoopVariable) Whether to check enhanced for-loop variable or not.
void	visitToken(DetailAST ast) Called to process a token.

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

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

public static final String MSG_KEY

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

See Also:

Constant Field Values

Constructor Detail

FinalLocalVariableCheck

public FinalLocalVariableCheck()

Method Detail

setValidateEnhancedForLoopVariable

public final void setValidateEnhancedForLoopVariable(boolean validateEnhancedForLoopVariable)

Whether to check enhanced for-loop variable or not.

Parameters:

validateEnhancedForLoopVariable - whether to check for-loop variable

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

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 Check

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

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.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process

leaveToken

public void leaveToken(DetailAST ast)

Description copied from class: Check

Called after all the child nodes have been process.

Overrides:

leaveToken in class Check

Parameters:

ast - the token leaving