com.puppycrawl.tools.checkstyle.checks.naming

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

public abstract class AbstractAccessControlNameCheck
extends AbstractNameCheck

Abstract class for checking a class member (field/method)'s name conforms to a format specified by the format property.

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:

1. applyToPublic, default true;
2. applyToProtected, default true;
3. applyToPackage, default true;
4. applyToPrivate, default true;

Author:

Rick Giles

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 and Description
protected	AbstractAccessControlNameCheck(String format) Creates a new AbstractAccessControlNameCheck instance.

Method Summary

Modifier and Type	Method and Description
protected 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, getClassLoader, getDefaultTokens, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAccessControlNameCheck

protected AbstractAccessControlNameCheck(String format)

Creates a new AbstractAccessControlNameCheck instance.

Parameters:

format - format to check with

Method Detail

mustCheckName

protected boolean mustCheckName(DetailAST ast)

Description copied from class: AbstractNameCheck

Decides whether the name of an AST should be checked against the format regexp.

Specified by:

mustCheckName in class AbstractNameCheck

Parameters:

ast - the AST to check.

Returns:

true if the IDENT subnode of ast should be checked against the format regexp.

shouldCheckInScope

protected boolean shouldCheckInScope(DetailAST modifiers)

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.