Class AbstractTypeParameterNameCheck
- 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.AbstractTypeParameterNameCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
@Deprecated public abstract class AbstractTypeParameterNameCheck extends AbstractNameCheck
Deprecated.Checkstyle will not support abstract checks anymore. UseAbstractNameCheck
instead.Abstract class for checking if a class/method type parameter's name conforms to a format specified by the format property.
This class extends
AbstractNameCheck
-
-
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 Modifier Constructor Description protected
AbstractTypeParameterNameCheck(String format)
Deprecated.Creates a newAbstractTypeParameterNameCheck
instance.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int[]
getAcceptableTokens()
Deprecated.The configurable token set.int[]
getDefaultTokens()
Deprecated.Returns the default token a check is interested in.protected abstract int
getLocation()
Deprecated.This method must be overridden to specify the location of the type parameter to check.protected boolean
mustCheckName(DetailAST ast)
Deprecated.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, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, 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 Detail
-
AbstractTypeParameterNameCheck
protected AbstractTypeParameterNameCheck(String format)
Deprecated.Creates a newAbstractTypeParameterNameCheck
instance.- Parameters:
format
- format to check with
-
-
Method Detail
-
getLocation
protected abstract int getLocation()
Deprecated.This method must be overridden to specify the location of the type parameter to check.- Returns:
TokenTypes.CLASS_DEF
orTokenTypes.METHOD_DEF
-
getDefaultTokens
public final int[] getDefaultTokens()
Deprecated.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 final int[] getAcceptableTokens()
Deprecated.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
-
mustCheckName
protected final boolean mustCheckName(DetailAST ast)
Deprecated.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.
-
-