Class AbstractClassNameCheck
- 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.AbstractClassNameCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public final class AbstractClassNameCheck extends AbstractCheck
Ensures that the names of abstract classes conforming to some pattern and check thatabstract
modifier exists.Rationale: Abstract classes are convenience base class implementations of interfaces. For this reason, it should be made obvious that a given class is abstract by prefacing the class name with 'Abstract'.
-
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
.
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.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private Pattern
format
Specify valid identifiers.private boolean
ignoreModifier
Control whether to ignore checking for theabstract
modifier on classes that match the name.private boolean
ignoreName
Control whether to ignore checking the name.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 Static 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.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
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.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, 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
-
-
-
-
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
-
ignoreModifier
private boolean ignoreModifier
Control whether to ignore checking for theabstract
modifier on classes that match the name.
-
ignoreName
private boolean 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.
-
-
Constructor Detail
-
AbstractClassNameCheck
public AbstractClassNameCheck()
-
-
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- Since:
- 5.3
-
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.- Since:
- 5.3
-
setFormat
public void setFormat(Pattern pattern)
Setter to specify valid identifiers.- Parameters:
pattern
- the new pattern- Since:
- 3.2
-
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
-
visitClassDef
private void visitClassDef(DetailAST ast)
Checks class definition.- Parameters:
ast
- class definition for check.
-
isAbstract
private static boolean isAbstract(DetailAST ast)
Checks if declared class is abstract or not.- Parameters:
ast
- class definition for check.- Returns:
- true if a given class declared as abstract.
-
isMatchingClassName
private boolean isMatchingClassName(String className)
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.
-
-