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
Ensures that the names of abstract classes conforming to some pattern
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. Type isjava.util.regex.Pattern
. Default value is"^Abstract.+$"
. -
Property
ignoreModifier
- Control whether to ignore checking for theabstract
modifier on classes that match the name. Type isboolean
. 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. Type isboolean
. Default value isfalse
.
To configure the check:
<module name="AbstractClassName"/>
Example:
abstract class AbstractFirstClass {} // OK abstract class SecondClass {} // violation, it should match pattern "^Abstract.+$" class AbstractThirdClass {} // violation, must be declared 'abstract' class FourthClass {} // OK
To configure the check so that it check name
but ignore abstract
modifier:
<module name="AbstractClassName"> <property name="ignoreModifier" value="true"/> </module>
Example:
abstract class AbstractFirstClass {} // OK abstract class SecondClass {} // violation, it should match pattern "^Abstract.+$" class AbstractThirdClass {} // OK, no "abstract" modifier class FourthClass {} // OK
To configure the check to ignore name validation when class declared as 'abstract'
<module name="AbstractClassName"> <property name="ignoreName" value="true"/> </module>
Example:
abstract class AbstractFirstClass {} // OK abstract class SecondClass {} // OK, name validation is ignored class AbstractThirdClass {} // violation, must be declared as 'abstract' class FourthClass {} // OK, no "abstract" modifier
To configure the check
with format
:
<module name="AbstractClassName"> <property name="format" value="^Generator.+$"/> </module>
Example:
abstract class GeneratorFirstClass {} // OK abstract class SecondClass {} // violation, must match pattern '^Generator.+$' class GeneratorThirdClass {} // violation, must be declared 'abstract' class FourthClass {} // OK, no "abstract" modifier
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
illegal.abstract.class.name
-
no.abstract.class.modifier
- Since:
- 3.2
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Pattern
Specify valid identifiers.private boolean
Control whether to ignore checking for theabstract
modifier on classes that match the name.private boolean
Control whether to ignore checking the name.static final String
A key is pointing to the warning message text in "messages.properties" file.static final String
A key is pointing to the warning message text in "messages.properties" file. -
Constructor Summary
Constructors -
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.private static boolean
isAbstract
(DetailAST ast) Checks if declared class is abstract or not.private boolean
isMatchingClassName
(String className) Returns true if class name matches format of abstract class names.void
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.private void
visitClassDef
(DetailAST ast) Checks class definition.void
visitToken
(DetailAST ast) Called to process a token.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, 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.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_ILLEGAL_ABSTRACT_CLASS_NAME
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
MSG_NO_ABSTRACT_CLASS_MODIFIER
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
ignoreModifier
private boolean ignoreModifierControl whether to ignore checking for theabstract
modifier on classes that match the name. -
ignoreName
private boolean ignoreNameControl whether to ignore checking the name. Realistically only useful if using the check to identify that match name and do not have theabstract
modifier. -
format
Specify valid identifiers.
-
-
Constructor Details
-
AbstractClassNameCheck
public AbstractClassNameCheck()
-
-
Method Details
-
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
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:
-
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:
-
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:
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
visitClassDef
Checks class definition.- Parameters:
ast
- class definition for check.
-
isAbstract
Checks if declared class is abstract or not.- Parameters:
ast
- class definition for check.- Returns:
- true if a given class declared as abstract.
-
isMatchingClassName
Returns true if class name matches format of abstract class names.- Parameters:
className
- class name for check.- Returns:
- true if class name matches format of abstract class names.
-