com.puppycrawl.tools.checkstyle.checks

Class FinalParametersCheck

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.FinalParametersCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class FinalParametersCheck
extends Check

Check that method/constructor/catch/foreach parameters are final. The user can set the token set to METHOD_DEF, CONSTRUCTOR_DEF, LITERAL_CATCH, FOR_EACH_CLAUSE or any combination of these token types, to control the scope of this check. Default scope is both METHOD_DEF and CONSTRUCTOR_DEF.

Check has an option ignorePrimitiveTypes which allows ignoring lack of final modifier at primitive datatype parameter. Default value false.

E.g.:

private void foo(int x) { ... } //parameter is of primitive type

Author:

lkuehne, o_sukhodolsky, Michael Studman, Aleksey Nesterenko

Constructor Summary

Constructors

Constructor and Description
FinalParametersCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
void	setIgnorePrimitiveTypes(boolean ignorePrimitiveTypes) Sets ignoring primitive types as params.
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, getRequiredTokens, 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

Constructor Detail

FinalParametersCheck

public FinalParametersCheck()

Method Detail

setIgnorePrimitiveTypes

public void setIgnorePrimitiveTypes(boolean ignorePrimitiveTypes)

Sets ignoring primitive types as params.

Parameters:

ignorePrimitiveTypes - true or false.

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

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