Package com.puppycrawl.tools.checkstyle.checks.naming

Class MethodNameCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

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 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.

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	allowClassName	Control whether to allow a method name to have the same name as the enclosing class name.
static final String	MSG_KEY	A key is pointing to the warning message text in "messages.properties" file.

Fields inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck

MSG_INVALID_PATTERN

Constructor Summary

Constructors

Constructor	Description
MethodNameCheck()	Creates a new MethodNameCheck instance.

Method Summary

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)	Setter to control whether to allow a method name to have the same name as the enclosing class name.
final void	setApplyToPackage(boolean applyTo)	Setter to control if check should apply to package-private members.
final void	setApplyToPrivate(boolean applyTo)	Setter to control if check should apply to private members.
final void	setApplyToProtected(boolean applyTo)	Setter to control if check should apply to protected members.
final void	setApplyToPublic(boolean applyTo)	Setter to control if check should apply to public members.
void	visitToken(DetailAST ast)	Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractAccessControlNameCheck

mustCheckName, shouldCheckInScope

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck

setFormat

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, 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.AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Details

MSG_KEY

public static final String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

• Constant Field Values

allowClassName

private boolean allowClassName

Control whether to allow a method name to have the same name as the enclosing class name. Setting this property false helps to avoid confusion between constructors and methods.

Constructor Details

MethodNameCheck

public MethodNameCheck()

Creates a new MethodNameCheck instance.

Method Details

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 class AbstractCheck

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 class AbstractCheck

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 class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

• TokenTypes

setApplyToPackage

public final void setApplyToPackage(boolean applyTo)

Setter to control if check should apply to package-private members.

Overrides:

setApplyToPackage in class AbstractAccessControlNameCheck

Parameters:

applyTo - new value of the property.

setApplyToPrivate

public final void setApplyToPrivate(boolean applyTo)

Setter to control if check should apply to private members.

Overrides:

setApplyToPrivate in class AbstractAccessControlNameCheck

Parameters:

applyTo - new value of the property.

setApplyToProtected

public final void setApplyToProtected(boolean applyTo)

Setter to control if check should apply to protected members.

Overrides:

setApplyToProtected in class AbstractAccessControlNameCheck

Parameters:

applyTo - new value of the property.

setApplyToPublic

public final void setApplyToPublic(boolean applyTo)

Setter to control if check should apply to public members.

Overrides:

setApplyToPublic in class AbstractAccessControlNameCheck

Parameters:

applyTo - new value of the property.

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractNameCheck

Parameters:

ast - the token to process

setAllowClassName

public void setAllowClassName(boolean allowClassName)

Setter to control whether to allow a method name to have the same name as the enclosing class name. Setting this property false helps to avoid confusion between constructors and methods.

Parameters:

allowClassName - true to allow false to disallow

Since:

5.0