Class FinalParametersCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Checks that parameters for methods, constructors, catch and for-each blocks are final. Interface, abstract, and native methods are not checked: the final keyword does not make sense for interface, abstract, and native method parameters as there is no code that could modify the parameter.
Rationale: Changing the value of parameters during the execution of the method's algorithm can be confusing and should be avoided. A great way to let the Java compiler prevent this coding style is to declare parameters final.
-
Property
ignorePrimitiveTypes
- Ignore primitive types as parameters. Type isboolean
. Default value isfalse
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. Default value is: METHOD_DEF, CTOR_DEF.
To configure the check to enforce final parameters for methods and constructors:
<module name="FinalParameters"/>
To configure the check to enforce final parameters only for constructors:
<module name="FinalParameters"> <property name="tokens" value="CTOR_DEF"/> </module>
To configure the check to allow ignoring primitive datatypes as parameters:
<module name="FinalParameters"> <property name="ignorePrimitiveTypes" value="true"/> </module>
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
final.parameter
- Since:
- 3.0
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
Ignore primitive types as parameters.static final String
A key is pointing to the warning message text in "messages.properties" file.Contains primitive datatypes. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate void
checkParam
(DetailAST param) Checks if the given parameter is final.int[]
The configurable token set.int[]
Returns the default token a check is interested in.int[]
The tokens that this check must be registered for.private boolean
isIgnoredParam
(DetailAST paramDef) Checks for skip current param due to ignorePrimitiveTypes option.void
setIgnorePrimitiveTypes
(boolean ignorePrimitiveTypes) Setter to ignore primitive types as parameters.private void
visitCatch
(DetailAST catchClause) Checks parameter of the catch block.private void
visitForEachClause
(DetailAST forEachClause) Checks parameter of the for each clause.private void
visitMethod
(DetailAST method) Checks parameters of the method or ctor.void
visitToken
(DetailAST ast) Called to process a token.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
primitiveDataTypes
Contains primitive datatypes. -
ignorePrimitiveTypes
private boolean ignorePrimitiveTypesIgnore primitive types as parameters.
-
-
Constructor Details
-
FinalParametersCheck
public FinalParametersCheck()
-
-
Method Details
-
setIgnorePrimitiveTypes
public void setIgnorePrimitiveTypes(boolean ignorePrimitiveTypes) Setter to ignore primitive types as parameters.- Parameters:
ignorePrimitiveTypes
- true or false.
-
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 classAbstractCheck
- Returns:
- the default tokens
- See Also:
-
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 classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
-
getRequiredTokens
public int[] getRequiredTokens()Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
visitMethod
Checks parameters of the method or ctor.- Parameters:
method
- method or ctor to check.
-
visitCatch
Checks parameter of the catch block.- Parameters:
catchClause
- catch block to check.
-
visitForEachClause
Checks parameter of the for each clause.- Parameters:
forEachClause
- for each clause to check.
-
checkParam
Checks if the given parameter is final.- Parameters:
param
- parameter to check.
-
isIgnoredParam
Checks for skip current param due to ignorePrimitiveTypes option.- Parameters:
paramDef
-PARAMETER_DEF
- Returns:
- true if param has to be skipped.
-