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.
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>
MSG_INVALID_PATTERN| Constructor and Description |
|---|
MethodNameCheck()
Creates a new
MethodNameCheck instance. |
| Modifier and Type | Method and Description |
|---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
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.
|
getApplyToPackage, getApplyToPrivate, getApplyToProtected, getApplyToPublic, mustCheckName, setApplyToPackage, setApplyToPrivate, setApplyToProtected, setApplyToPublic, shouldCheckInScopegetFormat, getRegexp, setCompileFlags, setFormatbeginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokensgetCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverityconfigure, contextualize, finishLocalSetup, getConfiguration, setupChildpublic MethodNameCheck()
MethodNameCheck instance.public int[] getDefaultTokens()
CheckgetDefaultTokens in class CheckTokenTypespublic void visitToken(DetailAST ast)
CheckvisitToken in class AbstractNameCheckast - the token to processpublic void setAllowClassName(boolean allowClassName)
allowClassName - true to allow false to disallowCopyright © 2001–2015. All rights reserved.