public class StaticVariableNameCheck extends AbstractAccessControlNameCheck
Checks that static, non-final variable names conform to a specified pattern.
format - Specifies valid identifiers.
Type is java.util.regex.Pattern.
Default value is "^[a-z][a-zA-Z0-9]*$".
applyToPublic - Controls whether to apply the check to public member.
Type is boolean.
Default value is true.
applyToProtected - Controls whether to apply the check to protected member.
Type is boolean.
Default value is true.
applyToPackage - Controls whether to apply the check to package-private member.
Type is boolean.
Default value is true.
applyToPrivate - Controls whether to apply the check to private member.
Type is boolean.
Default value is true.
An example of how to configure the check is:
<module name="StaticVariableName"/>
Code Example:
class MyClass {
public static int goodStatic = 2; // OK
private static int BadStatic = 2; // violation, name 'BadStatic'
// must match pattern '^[a-z][a-zA-Z0-9]*$'
}
An example of how to suppress the check to public and protected types is:
<module name="StaticVariableName"> <property name="applyToPublic" value="false"/> <property name="applyToProtected" value="false"/> </module>
Code Example:
class MyClass {
public static int GoodStatic1 = 2; // OK
protected static int GoodStatic2 = 2; //OK
private static int goodStatic = 2 // OK
private static int BadStatic = 2; // violation, name 'BadStatic'
// must match pattern '^[a-z][a-zA-Z0-9]*$'
}
An example of how to configure the check for names that begin with a lower case letter, followed by letters, digits, and underscores. Also, suppress the check from being applied to private and package-private types:
<module name="StaticVariableName"> <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/> <property name="applyToPrivate" value="false"/> <property name="applyToPackage" value="false"/> </module>
Code Example:
class MyClass {
public static int good_static = 2; // OK
public static int Bad_Static = 2; // violation, name 'Bad_Static'
// must match pattern '^[a-z](_?[a-zA-Z0-9]+)*$'
private static int Good_Static1 = 2; // OK
static int Good_Static2 = 2; // OK
}
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
name.invalidPattern
AutomaticBean.OutputStreamOptionsMSG_INVALID_PATTERN| Constructor and Description |
|---|
StaticVariableNameCheck()
Creates a new
StaticVariableNameCheck instance. |
| Modifier and Type | Method and 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.
|
protected boolean |
mustCheckName(DetailAST ast)
Decides whether the name of an AST should be checked against
the format regexp.
|
setApplyToPackage, setApplyToPrivate, setApplyToProtected, setApplyToPublic, shouldCheckInScopesetFormat, visitTokenbeginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic StaticVariableNameCheck()
StaticVariableNameCheck instance.public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypesprotected final boolean mustCheckName(DetailAST ast)
AbstractNameCheckmustCheckName in class AbstractAccessControlNameCheckast - the AST to check.Copyright © 2001–2020. All rights reserved.