Class AbstractAccessControlNameCheck
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.AbstractAccessControlNameCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
- Direct Known Subclasses:
ConstantNameCheck
,MemberNameCheck
,MethodNameCheck
,StaticVariableNameCheck
,TypeNameCheck
Abstract class for checking a class member (field/method)'s name conforms to
a specified pattern.
This class extends AbstractNameCheck
with support for access level
restrictions. This allows the check to be configured to be applied to one of
the four Java access levels: public
, protected
,
"package"
, and private
.
Level is configured using the following properties:
- applyToPublic, default true;
- applyToProtected, default true;
- applyToPackage, default true;
- applyToPrivate, default true;
-
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
ConstructorsModifierConstructorDescriptionprotected
AbstractAccessControlNameCheck
(String format) Creates a newAbstractAccessControlNameCheck
instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
mustCheckName
(DetailAST ast) Decides whether the name of an AST should be checked against the format regexp.void
setApplyToPackage
(boolean applyTo) Sets whether we should apply the check to package-private members.void
setApplyToPrivate
(boolean applyTo) Sets whether we should apply the check to private members.void
setApplyToProtected
(boolean applyTo) Sets whether we should apply the check to protected members.void
setApplyToPublic
(boolean applyTo) Sets whether we should apply the check to public members.protected boolean
shouldCheckInScope
(DetailAST modifiers) Should we check member with given modifiers.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, getAcceptableTokens, getDefaultTokens, getFileContents, getLine, getLines, getMessages, getRequiredTokens, getTabWidth, getTokenNames, 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
-
Constructor Details
-
AbstractAccessControlNameCheck
Creates a newAbstractAccessControlNameCheck
instance.- Parameters:
format
- format to check with
-
-
Method Details
-
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.
-
shouldCheckInScope
Should we check member with given modifiers.- Parameters:
modifiers
- modifiers of member to check.- Returns:
- true if we should check such member.
-
setApplyToPublic
public void setApplyToPublic(boolean applyTo) Sets whether we should apply the check to public members.- Parameters:
applyTo
- new value of the property.
-
setApplyToProtected
public void setApplyToProtected(boolean applyTo) Sets whether we should apply the check to protected members.- Parameters:
applyTo
- new value of the property.
-
setApplyToPackage
public void setApplyToPackage(boolean applyTo) Sets whether we should apply the check to package-private members.- Parameters:
applyTo
- new value of the property.
-
setApplyToPrivate
public void setApplyToPrivate(boolean applyTo) Sets whether we should apply the check to private members.- Parameters:
applyTo
- new value of the property.
-