Class AbstractClassNameCheck
- 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.AbstractClassNameCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public final class AbstractClassNameCheck extends AbstractCheck
Ensures that the names of abstract classes conforming to some regular expression and check that
abstract
modifier exists.Rationale: Abstract classes are convenience base class implementations of interfaces, not types as such. As such they should be named to indicate this. Also if names of classes starts with 'Abstract' it's very convenient that they will have abstract modifier.
-
Property
format
- Specify valid identifiers. Default value is"^Abstract.+$"
. -
Property
ignoreModifier
- Control whether to ignore checking for theabstract
modifier on classes that match the name. Default value isfalse
. -
Property
ignoreName
- Control whether to ignore checking the name. Realistically only useful if using the check to identify that match name and do not have theabstract
modifier. Default value isfalse
.
The following example shows how to configure the
AbstractClassName
to checks names, but ignore missingabstract
modifiers:Configuration:
<module name="AbstractClassName"> <property name="ignoreModifier" value="true"/> </module>
Example:
abstract class AbstractFirstClass {} // OK abstract class SecondClass {} // violation, it should match the pattern "^Abstract.+$" class AbstractThirdClass {} // OK, no "abstract" modifier
- Since:
- 3.2
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description static String
MSG_ILLEGAL_ABSTRACT_CLASS_NAME
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_NO_ABSTRACT_CLASS_MODIFIER
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description AbstractClassNameCheck()
-
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.void
setFormat(Pattern pattern)
Setter to specify valid identifiers.void
setIgnoreModifier(boolean value)
Setter to control whether to ignore checking for theabstract
modifier on classes that match the name.void
setIgnoreName(boolean value)
Setter to control whether to ignore checking the name.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, 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
-
-
-
-
Field Detail
-
MSG_ILLEGAL_ABSTRACT_CLASS_NAME
public static final String MSG_ILLEGAL_ABSTRACT_CLASS_NAME
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_NO_ABSTRACT_CLASS_MODIFIER
public static final String MSG_NO_ABSTRACT_CLASS_MODIFIER
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
-
Method Detail
-
setIgnoreModifier
public void setIgnoreModifier(boolean value)
Setter to control whether to ignore checking for theabstract
modifier on classes that match the name.- Parameters:
value
- new value
-
setIgnoreName
public void setIgnoreName(boolean value)
Setter to control whether to ignore checking the name. Realistically only useful if using the check to identify that match name and do not have theabstract
modifier.- Parameters:
value
- new value.
-
setFormat
public void setFormat(Pattern pattern)
Setter to specify valid identifiers.- Parameters:
pattern
- the new pattern
-
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
-
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
-
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
-
visitToken
public void visitToken(DetailAST ast)
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
-