Class ParameterNameCheck
- 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.naming.AbstractNameCheck
-
- com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class ParameterNameCheck extends AbstractNameCheck
Checks that method and
catch
parameter names conform to a format specified by the format property. The format is aregular expression
and defaults to ^[a-z][a-zA-Z0-9]*$.The check has the following options:
ignoreOverridden - allows to skip methods with Override annotation from validation. Default values is false .
accessModifiers - access modifiers of methods which should to be checked. Default value is public, protected, package, private .
An example of how to configure the check:<module name="ParameterName"/>
An example of how to configure the check for names that begin with a lower case letter, followed by letters, digits, and underscores:
<module name="ParameterName"> <property name="format" value="^[a-z][_a-zA-Z0-9]+$"/> </module>
An example of how to configure the check to skip methods with Override annotation from validation:
<module name="ParameterName"> <property name="ignoreOverridden" value="true"/> </module>
-
-
Field Summary
Fields Modifier and Type Field Description private AccessModifier[]
accessModifiers
Access modifiers of methods which should be 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.private static AccessModifier
getAccessModifier(DetailAST ast)
Returns the access modifier of the method/constructor at the specified AST.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(AccessModifier 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(AccessModifier... accessModifiers)
Sets access modifiers of methods which should be checked.void
setIgnoreOverridden(boolean ignoreOverridden)
Sets whether 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, 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
-
-
-
-
Field Detail
-
ignoreOverridden
private boolean ignoreOverridden
Allows to skip methods with Override annotation from validation.
-
accessModifiers
private AccessModifier[] accessModifiers
Access modifiers of methods which should be checked.
-
-
Method Detail
-
setIgnoreOverridden
public void setIgnoreOverridden(boolean ignoreOverridden)
Sets whether to skip methods with Override annotation from validation.- Parameters:
ignoreOverridden
- Flag for skipping methods with Override annotation.
-
setAccessModifiers
public void setAccessModifiers(AccessModifier... accessModifiers)
Sets access modifiers of methods which should be checked.- Parameters:
accessModifiers
- access modifiers of methods which should be checked.
-
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.
-
getAccessModifier
private static AccessModifier getAccessModifier(DetailAST ast)
Returns the access modifier of the method/constructor at the specified AST. If the method is in an interface or annotation block, the access modifier is assumed to be public.- Parameters:
ast
- the token of the method/constructor.- Returns:
- the access modifier of the method/constructor.
-
matchAccessModifiers
private boolean matchAccessModifiers(AccessModifier 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.
-
-