Package com.puppycrawl.tools.checkstyle.checks.coding

Class OverloadMethodsDeclarationOrderCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class OverloadMethodsDeclarationOrderCheck
extends AbstractCheck

Checks that overloaded methods are grouped together. Overloaded methods have the same name but different signatures where the signature can differ by the number of input parameters or type of input parameters or both.

Since:

5.8

Nested Class Summary

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

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSG_KEY	A key is pointing to the warning message text in "messages.properties" file.
static final String	MSG_ORDER	A key is pointing to the warning message text in "messages.properties" file.
private boolean	orderByIncreasingParameterCount	Control whether to order overloaded methods by increasing parameter count.

Constructor Summary

Constructors

Constructor	Description
OverloadMethodsDeclarationOrderCheck()

Method Summary

Modifier and Type	Method	Description
private void	checkMethodOrdering(DetailAST currentMethod, String methodName, Map<String,Boolean> methodIsOrderedMap, Map<String,Integer> methodParameterCountMap)	Checks that overloaded methods are ordered with increasing parameter count or not.
private void	checkOverloadMethodsGrouping(DetailAST objectBlock)	Checks that if overload methods are grouped together they should not be separated from each other.
int[]	getAcceptableTokens()	The configurable token set.
int[]	getDefaultTokens()	Returns the default token a check is interested in.
private static int	getParameterCount(DetailAST method)	Get the parameter count of a method.
int[]	getRequiredTokens()	The tokens that this check must be registered for.
void	setOrderByIncreasingParameterCount(boolean orderByIncreasingParameterCount)	Setter to control whether to enforce order by increasing parameter count (arity) or not.
void	visitToken(DetailAST ast)	Called to process a token.

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

MSG_ORDER

public static final String MSG_ORDER

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

See Also:

• Constant Field Values

orderByIncreasingParameterCount

private boolean orderByIncreasingParameterCount

Control whether to order overloaded methods by increasing parameter count.

Constructor Details

OverloadMethodsDeclarationOrderCheck

public OverloadMethodsDeclarationOrderCheck()

Method Details

setOrderByIncreasingParameterCount

public void setOrderByIncreasingParameterCount(boolean orderByIncreasingParameterCount)

Setter to control whether to enforce order by increasing parameter count (arity) or not.

Parameters:

orderByIncreasingParameterCount - true if order by increasing parameter count is required.

Since:

13.7.0

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

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process

checkOverloadMethodsGrouping

private void checkOverloadMethodsGrouping(DetailAST objectBlock)

Checks that if overload methods are grouped together they should not be separated from each other.

Parameters:

objectBlock - is a class, interface or enum object block.

checkMethodOrdering

private void checkMethodOrdering(DetailAST currentMethod,
 String methodName,
 Map<String,Boolean> methodIsOrderedMap,
 Map<String,Integer> methodParameterCountMap)

Checks that overloaded methods are ordered with increasing parameter count or not.

Parameters:

currentMethod - ast of the method.

methodName - method name.

methodIsOrderedMap - is a map of method names to booleans indicating whether the method is ordered.

methodParameterCountMap - is a map of method names to integers indicating the parameter count of the previous similar method.

getParameterCount

private static int getParameterCount(DetailAST method)

Get the parameter count of a method.

Parameters:

method - the method AST

Returns:

the parameter count of the method