Class MemberNameCheck
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.AbstractAccessControlNameCheck
com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Checks that instance variable names conform to a specified pattern.
-
Property
format
- Specifies valid identifiers. Type isjava.util.regex.Pattern
. Default value is"^[a-z][a-zA-Z0-9]*$"
. -
Property
applyToPublic
- Controls whether to apply the check to public member. Type isboolean
. Default value istrue
. -
Property
applyToProtected
- Controls whether to apply the check to protected member. Type isboolean
. Default value istrue
. -
Property
applyToPackage
- Controls whether to apply the check to package-private member. Type isboolean
. Default value istrue
. -
Property
applyToPrivate
- Controls whether to apply the check to private member. Type isboolean
. Default value istrue
.
To configure the check:
<module name="MemberName"/>
Code Example:
class MyClass { public int num1; // OK protected int num2; // OK final int num3 = 3; // OK private int num4; // OK static int num5; // ignored: not an instance variable public static final int CONSTANT = 1; // ignored: not an instance variable public int NUM1; // violation, name 'NUM1' // must match pattern '^[a-z][a-zA-Z0-9]*$' protected int NUM2; // violation, name 'NUM2' // must match pattern '^[a-z][a-zA-Z0-9]*$' final int NUM3; // violation, name 'NUM3' // must match pattern '^[a-z][a-zA-Z0-9]*$' private int NUM4; // violation, name 'NUM4' // must match pattern '^[a-z][a-zA-Z0-9]*$' }
An example of how to configure the check for names that begin with
"m"
, followed by an upper case letter, and then letters
and digits. Also, suppress the check from being applied to protected
and package-private member:
<module name="MemberName"> <property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/> <property name="applyToProtected" value="false"/> <property name="applyToPackage" value="false"/> </module>
Code Example:
class MyClass { public int num1; // violation, name 'num1' // must match pattern '^m[A-Z][a-zA-Z0-9]*$' protected int num2; // OK int num3; // OK private int num4; // violation, name 'num4' // must match pattern '^m[A-Z][a-zA-Z0-9]*$' }
An example of how to suppress the check which is applied to public and private member:
<module name="MemberName"> <property name="applyToPublic" value="false"/> <property name="applyToPrivate" value="false"/> </module>
Code Example:
class MyClass { public int NUM1; // OK protected int NUM2; // violation, name 'NUM2' // must match pattern '^[a-z][a-zA-Z0-9]*$' int NUM3; // violation, name 'NUM3' // must match pattern '^[a-z][a-zA-Z0-9]*$' private int NUM4; // OK }
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.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
Fields inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
MSG_INVALID_PATTERN
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint[]
The configurable token set.int[]
Returns the default token a check is interested in.int[]
The tokens that this check must be registered for.protected final boolean
mustCheckName
(DetailAST ast) Decides whether the name of an AST should be checked against the format regexp.Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
setApplyToPackage, setApplyToPrivate, setApplyToProtected, setApplyToPublic, shouldCheckInScope
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
setFormat, visitToken
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, 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
-
Constructor Details
-
MemberNameCheck
public MemberNameCheck()Creates a newMemberNameCheck
instance.
-
-
Method Details
-
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:
-
mustCheckName
Description copied from class:AbstractNameCheck
Decides whether the name of an AST should be checked against the format regexp.- Overrides:
mustCheckName
in classAbstractAccessControlNameCheck
- Parameters:
ast
- the AST to check.- Returns:
- true if the IDENT subnode of ast should be checked against the format regexp.
-