Class IllegalIdentifierNameCheck
- 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.IllegalIdentifierNameCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
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.-
Property
format
- Sets the pattern to match valid identifiers. Type isjava.util.regex.Pattern
. Default value is"(?i)^(?!(record|yield|var|permits|sealed)$).+$"
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. 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.
Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
name.invalidPattern
- Since:
- 8.36
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
-
Fields inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
MSG_INVALID_PATTERN
-
-
Constructor Summary
Constructors Constructor Description IllegalIdentifierNameCheck()
Creates a newIllegalIdentifierNameCheck
instance.
-
Method Summary
All 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.protected 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.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
-
-
-
-
Constructor Detail
-
IllegalIdentifierNameCheck
public IllegalIdentifierNameCheck()
Creates a newIllegalIdentifierNameCheck
instance.
-
-
Method Detail
-
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.
-
-