Class MethodNameCheck
- 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
-
- com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class MethodNameCheck extends AbstractAccessControlNameCheck
Checks that method names conform to a format specified by the format property. The format is a
regular expression
and defaults to ^[a-z][a-zA-Z0-9]*$.Also, checks if a method name has the same name as the residing class. The default is false (it is not allowed). It is legal in Java to have method with the same name as a class. As long as a return type is specified it is a method and not a constructor which it could be easily confused as.
Does not check-style the name of an overridden methods
because the developer does not have a choice in renaming such methods.An example of how to configure the check is:
<module name="MethodName"/>
An example of how to configure the check for names that begin with a lower case letter, followed by letters, digits, and underscores is:
<module name="MethodName"> <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/> </module>
An example of how to configure the check to allow method names to be equal to the residing class name is:
<module name="MethodName"> <property name="allowClassName" value="true"/> </module>
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
allowClassName
For allowing method name to be the same as the class name.private static java.lang.String
CANONICAL_OVERRIDE
CanonicalOverride
annotation name.static java.lang.String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.private static java.lang.String
OVERRIDE
Override
annotation name.-
Fields inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
MSG_INVALID_PATTERN
-
-
Constructor Summary
Constructors Constructor Description MethodNameCheck()
Creates a newMethodNameCheck
instance.
-
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
setAllowClassName(boolean allowClassName)
Sets the property for allowing a method to be the same name as a class.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck
mustCheckName, setApplyToPackage, setApplyToPrivate, setApplyToProtected, setApplyToPublic, shouldCheckInScope
-
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
setFormat
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
-
-
-
-
Field Detail
-
MSG_KEY
public static final java.lang.String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
OVERRIDE
private static final java.lang.String OVERRIDE
Override
annotation name.- See Also:
- Constant Field Values
-
CANONICAL_OVERRIDE
private static final java.lang.String CANONICAL_OVERRIDE
CanonicalOverride
annotation name.- See Also:
- Constant Field Values
-
allowClassName
private boolean allowClassName
For allowing method name to be the same as the class name.
-
-
Method Detail
-
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
-
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
-
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
-
visitToken
public void visitToken(DetailAST ast)
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractNameCheck
- Parameters:
ast
- the token to process
-
setAllowClassName
public void setAllowClassName(boolean allowClassName)
Sets the property for allowing a method to be the same name as a class.- Parameters:
allowClassName
- true to allow false to disallow
-
-