public class MethodNameCheck extends AbstractAccessControlNameCheck
Checks that method names conform to a specified pattern.
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.
format - Specifies valid identifiers.
Type is java.util.regex.Pattern.
Default value is "^[a-z][a-zA-Z0-9]*$".
allowClassName - Controls whether to allow a method name to have the same name
as the residing class name. This is not to be confused with a constructor. An easy mistake is
to place a return type on a constructor declaration which turns it into a method. For example:
class MyClass {
public void MyClass() {} //this is a method
public MyClass() {} //this is a constructor
}
Type is boolean.
Default value is false.
applyToPublic - Controls whether to apply the check to public member.
Type is boolean.
Default value is true.
applyToProtected - Controls whether to apply the check to protected member.
Type is boolean.
Default value is true.
applyToPackage - Controls whether to apply the check to package-private member.
Type is boolean.
Default value is true.
applyToPrivate - Controls whether to apply the check to private member.
Type is boolean.
Default value is true.
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>
Code Example:
class MyClass {
public void myMethod() {} // OK
public void MyMethod() {} // violation, name "MyMethod"
// should match the pattern "^[a-z](_?[a-zA-Z0-9]+)*$"
}
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="format" value="^[a-zA-Z](_?[a-zA-Z0-9]+)*$"/>
<property name="allowClassName" value="true"/>
</module>
Code Example:
class MyClass {
public MyClass() {} // OK
public void MyClass() {} // OK, method Name 'MyClass' is allowed to be
// equal to the enclosing class name
}
An example of how to configure the check to disallow method names to be equal to the residing class name is:
<module name="MethodName">
<property name="format" value="^[a-zA-Z](_?[a-zA-Z0-9]+)*$"/>
<property name="allowClassName" value="false"/>
</module>
Code Example:
class MyClass {
public MyClass() {} // OK
public void MyClass() {} // violation, method Name 'MyClass' must not
// equal the enclosing class name
}
An example of how to suppress the check to public and protected methods:
<module name="MethodName">
<property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
<property name="applyToPublic" value="false"/>
<property name="applyToProtected" value="false"/>
</module>
Code Example:
class MyClass {
public void FirstMethod() {} // OK
protected void SecondMethod() {} // OK
private void ThirdMethod() {} // violation, name 'ThirdMethod' must match
// pattern '^[a-z](_?[a-zA-Z0-9]+)*$'
void FourthMethod() {} // violation, name 'FourthMethod' must match
// pattern '^[a-z](_?[a-zA-Z0-9]+)*$'
}
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
method.name.equals.class.name
name.invalidPattern
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
static String |
MSG_KEY
A key is pointing to the warning message text in "messages.properties"
file.
|
MSG_INVALID_PATTERN| Constructor and Description |
|---|
MethodNameCheck()
Creates a new
MethodNameCheck instance. |
| Modifier and Type | Method and 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)
Setter to controls whether to allow a method name to have the same name as the residing
class name.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
mustCheckName, setApplyToPackage, setApplyToPrivate, setApplyToProtected, setApplyToPublic, shouldCheckInScopesetFormatbeginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic static final String MSG_KEY
public MethodNameCheck()
MethodNameCheck instance.public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypespublic void visitToken(DetailAST ast)
AbstractCheckvisitToken in class AbstractNameCheckast - the token to processpublic void setAllowClassName(boolean allowClassName)
class MyClass {
public void MyClass() {} //this is a method
public MyClass() {} //this is a constructor
}
allowClassName - true to allow false to disallowCopyright © 2001–2020. All rights reserved.