Class MethodTypeParameterNameCheck
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.MethodTypeParameterNameCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Checks that method type parameter names conform to a specified pattern.
-
Property
format
- Sets the pattern to match valid identifiers. Type isjava.util.regex.Pattern
. Default value is"^[A-Z]$"
.
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
name.invalidPattern
- Since:
- 5.0
-
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
ConstructorDescriptionCreates a newMethodTypeParameterNameCheck
instance. -
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.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 Details
-
MethodTypeParameterNameCheck
public MethodTypeParameterNameCheck()Creates a newMethodTypeParameterNameCheck
instance.
-
-
Method Details
-
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
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
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.- 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.
-