public class IllegalIdentifierNameCheck extends AbstractNameCheck
Checks identifiers with a pattern for a set of illegal names, such as those that are restricted or contextual keywords. Examples include "yield", "record", "_", and "var". Please read more at Java Language Specification to get to know more about restricted keywords. Since this check uses a pattern to specify valid identifiers, users can also prohibit the usage of certain symbols, such as "$", or any non-ascii character.
format - Specifies valid identifiers.
Type is java.util.regex.Pattern.
Default value is "(?i)^(?!(record|yield|var|permits|sealed|_)$).+$".
tokens - tokens to check
Type is java.lang.String[].
Validation type is tokenSet.
Default value is:
CLASS_DEF,
INTERFACE_DEF,
ENUM_DEF,
ANNOTATION_DEF,
ANNOTATION_FIELD_DEF,
PARAMETER_DEF,
VARIABLE_DEF,
METHOD_DEF,
ENUM_CONSTANT_DEF,
PATTERN_VARIABLE_DEF,
RECORD_DEF,
RECORD_COMPONENT_DEF,
LAMBDA.
To configure the check:
Configuration:
<module name="IllegalIdentifierName"/>
Example:
public class TestClass {
public static void main(String... args) {
var var = 4; // violation, "var" should not be used as an identifier.
int record = 15; // violation, "record" should not be used as an identifier.
String yield = "yield"; // violation, "yield" should not be used as an identifier.
record Record // violation, "Record" should not be used as an identifier.
(Record record) { // violation, "record" should not be used as an identifier.
}
String yieldString = "yieldString"; // ok, part of another word
record MyRecord(){} // ok, part of another word
var variable = 2; // ok, part of another word
String _; // violation, underscore should not be used as an identifier.
}
}
To configure the check to include "open" and "transitive" in the set of illegal identifiers:
Configuration:
<module name="IllegalIdentifierName">
<property name="format" value="(?i)^(?!(record|yield|var
|permits|sealed|open|transitive|_)$).+$"/>
</module>
Example:
public class TestClass {
public static void main(String... args) {
int open = 4; // violation, "open" should not be used as an identifier
Object transitive = "transitive"; // violation, "transitive" should not
// be used as an identifier
int openInt = 4; // ok, "open" is part of another word
Object transitiveObject = "transitiveObject"; // ok, "transitive" is part of another word
}
}
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
name.invalidPattern
AutomaticBean.OutputStreamOptionsMSG_INVALID_PATTERN| Constructor and Description |
|---|
IllegalIdentifierNameCheck()
Creates a new
IllegalIdentifierNameCheck 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.
|
setFormat, visitTokenbeginTree, clearViolations, destroy, finishTree, getFileContents, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic IllegalIdentifierNameCheck()
IllegalIdentifierNameCheck instance.public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypesprotected boolean mustCheckName(DetailAST ast)
AbstractNameCheckmustCheckName in class AbstractNameCheckast - the AST to check.Copyright © 2001-2022. All Rights Reserved.