Class ParameterNameCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
-
- com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class ParameterNameCheck extends AbstractNameCheck
Checks that method parameter names conform to a specified pattern. By usingaccessModifiers
property it is possible to specify different formats for methods at different visibility levels.To validate
catch
parameters please use CatchParameterName.To validate lambda parameters please use LambdaParameterName.
-
Property
accessModifiers
- Access modifiers of methods where parameters are checked. Type iscom.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption[]
. Default value ispublic, protected, package, private
. -
Property
format
- Sets the pattern to match valid identifiers. Type isjava.util.regex.Pattern
. Default value is"^[a-z][a-zA-Z0-9]*$"
. -
Property
ignoreOverridden
- Allows to skip methods with Override annotation from validation. Type isboolean
. Default value isfalse
.
Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
name.invalidPattern
- Since:
- 3.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private AccessModifierOption[]
accessModifiers
Access modifiers of methods where parameters are checked.private boolean
ignoreOverridden
Allows to skip methods with Override annotation from validation.-
Fields inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
MSG_INVALID_PATTERN
-
-
Constructor Summary
Constructors Constructor Description ParameterNameCheck()
Creates a newParameterNameCheck
instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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 static boolean
isOverriddenMethod(DetailAST ast)
Checks whether a method is annotated with Override annotation.private boolean
matchAccessModifiers(AccessModifierOption accessModifier)
Checks whether a method has the correct access modifier to be checked.protected boolean
mustCheckName(DetailAST ast)
Decides whether the name of an AST should be checked against the format regexp.void
setAccessModifiers(AccessModifierOption... accessModifiers)
Setter to access modifiers of methods where parameters are checked.void
setIgnoreOverridden(boolean ignoreOverridden)
Setter to allows to skip methods with Override annotation from validation.-
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
setFormat, visitToken
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, 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.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild
-
-
-
-
Field Detail
-
ignoreOverridden
private boolean ignoreOverridden
Allows to skip methods with Override annotation from validation.
-
accessModifiers
private AccessModifierOption[] accessModifiers
Access modifiers of methods where parameters are checked.
-
-
Constructor Detail
-
ParameterNameCheck
public ParameterNameCheck()
Creates a newParameterNameCheck
instance.
-
-
Method Detail
-
setIgnoreOverridden
public void setIgnoreOverridden(boolean ignoreOverridden)
Setter to allows to skip methods with Override annotation from validation.- Parameters:
ignoreOverridden
- Flag for skipping methods with Override annotation.- Since:
- 6.12.1
-
setAccessModifiers
public void setAccessModifiers(AccessModifierOption... accessModifiers)
Setter to access modifiers of methods where parameters are checked.- Parameters:
accessModifiers
- access modifiers of methods which should be checked.- Since:
- 7.5
-
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:
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 classAbstractCheck
- 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 classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
mustCheckName
protected boolean mustCheckName(DetailAST ast)
Description copied from class:AbstractNameCheck
Decides whether the name of an AST should be checked against the format regexp.- Specified by:
mustCheckName
in classAbstractNameCheck
- Parameters:
ast
- the AST to check.- Returns:
- true if the IDENT subnode of ast should be checked against the format regexp.
-
matchAccessModifiers
private boolean matchAccessModifiers(AccessModifierOption accessModifier)
Checks whether a method has the correct access modifier to be checked.- Parameters:
accessModifier
- the access modifier of the method.- Returns:
- whether the method matches the expected access modifier.
-
isOverriddenMethod
private static boolean isOverriddenMethod(DetailAST ast)
Checks whether a method is annotated with Override annotation.- Parameters:
ast
- method parameter definition token.- Returns:
- true if a method is annotated with Override annotation.
-
-