Class MethodCountCheck
- 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.sizes.MethodCountCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public final class MethodCountCheck extends AbstractCheck
Checks the number of methods declared in each type declaration by access modifier or total count.This check can be configured to flag classes that define too many methods to prevent the class from getting too complex. Counting can be customized to prevent too many total methods in a type definition (
maxTotal
), or to prevent too many methods of a specific access modifier (private
,package
,protected
orpublic
). Each count is completely separated to customize how many methods of each you want to allow. For example, specifying amaxTotal
of 10, still means you can prevent more than 0maxPackage
methods. A violation won't appear for 8 public methods, but one will appear if there is also 3 private methods or any package-private methods.Methods defined in anonymous classes are not counted towards any totals. Counts only go towards the main type declaration parent, and are kept separate from it's children's inner types.
public class ExampleClass { public enum Colors { RED, GREEN, YELLOW; public String getRGB() { ... } // NOT counted towards ExampleClass } public void example() { // counted towards ExampleClass Runnable r = (new Runnable() { public void run() { ... } // NOT counted towards ExampleClass, won't produce any violations }); } public static class InnerExampleClass { protected void example2() { ... } // NOT counted towards ExampleClass, // but counted towards InnerExampleClass } }
-
Property
maxPackage
- Specify the maximum number ofpackage
methods allowed. Type isint
. Default value is100
. -
Property
maxPrivate
- Specify the maximum number ofprivate
methods allowed. Type isint
. Default value is100
. -
Property
maxProtected
- Specify the maximum number ofprotected
methods allowed. Type isint
. Default value is100
. -
Property
maxPublic
- Specify the maximum number ofpublic
methods allowed. Type isint
. Default value is100
. -
Property
maxTotal
- Specify the maximum number of methods allowed at all scope levels. Type isint
. Default value is100
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. Default value is: CLASS_DEF, ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, ANNOTATION_DEF, RECORD_DEF.
Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
too.many.methods
-
too.many.packageMethods
-
too.many.privateMethods
-
too.many.protectedMethods
-
too.many.publicMethods
- Since:
- 5.3
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
MethodCountCheck.MethodCounter
Marker class used to collect data about the number of methods per class.-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private Deque<MethodCountCheck.MethodCounter>
counters
Maintains stack of counters, to support inner types.private static int
DEFAULT_MAX_METHODS
Default maximum number of methods.private int
maxPackage
Specify the maximum number ofpackage
methods allowed.private int
maxPrivate
Specify the maximum number ofprivate
methods allowed.private int
maxProtected
Specify the maximum number ofprotected
methods allowed.private int
maxPublic
Specify the maximum number ofpublic
methods allowed.private int
maxTotal
Specify the maximum number of methods allowed at all scope levels.static String
MSG_MANY_METHODS
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_PACKAGE_METHODS
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_PRIVATE_METHODS
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_PROTECTED_METHODS
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_PUBLIC_METHODS
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description MethodCountCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
checkCounters(MethodCountCheck.MethodCounter counter, DetailAST ast)
Check the counters and report violations.private void
checkMax(int max, int value, String msg, DetailAST ast)
Utility for reporting if a maximum has been exceeded.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.private boolean
isInLatestScopeDefinition(DetailAST methodDef)
Checks if there is a scope definition to check and that the method is found inside that scope (class, enum, etc.).void
leaveToken(DetailAST ast)
Called after all the child nodes have been process.private void
raiseCounter(DetailAST method)
Determine the visibility modifier and raise the corresponding counter.void
setMaxPackage(int value)
Setter to specify the maximum number ofpackage
methods allowed.void
setMaxPrivate(int value)
Setter to specify the maximum number ofprivate
methods allowed.void
setMaxProtected(int value)
Setter to specify the maximum number ofprotected
methods allowed.void
setMaxPublic(int value)
Setter to specify the maximum number ofpublic
methods allowed.void
setMaxTotal(int value)
Setter to specify the maximum number of methods allowed at all scope levels.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, 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
-
-
-
-
Field Detail
-
MSG_PRIVATE_METHODS
public static final String MSG_PRIVATE_METHODS
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_PACKAGE_METHODS
public static final String MSG_PACKAGE_METHODS
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_PROTECTED_METHODS
public static final String MSG_PROTECTED_METHODS
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_PUBLIC_METHODS
public static final String MSG_PUBLIC_METHODS
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_MANY_METHODS
public static final String MSG_MANY_METHODS
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
DEFAULT_MAX_METHODS
private static final int DEFAULT_MAX_METHODS
Default maximum number of methods.- See Also:
- Constant Field Values
-
counters
private final Deque<MethodCountCheck.MethodCounter> counters
Maintains stack of counters, to support inner types.
-
maxPrivate
private int maxPrivate
Specify the maximum number ofprivate
methods allowed.
-
maxPackage
private int maxPackage
Specify the maximum number ofpackage
methods allowed.
-
maxProtected
private int maxProtected
Specify the maximum number ofprotected
methods allowed.
-
maxPublic
private int maxPublic
Specify the maximum number ofpublic
methods allowed.
-
maxTotal
private int maxTotal
Specify the maximum number of methods allowed at all scope levels.
-
-
Constructor Detail
-
MethodCountCheck
public MethodCountCheck()
-
-
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 classAbstractCheck
- Parameters:
ast
- the token to process
-
leaveToken
public void leaveToken(DetailAST ast)
Description copied from class:AbstractCheck
Called after all the child nodes have been process.- Overrides:
leaveToken
in classAbstractCheck
- Parameters:
ast
- the token leaving
-
isInLatestScopeDefinition
private boolean isInLatestScopeDefinition(DetailAST methodDef)
Checks if there is a scope definition to check and that the method is found inside that scope (class, enum, etc.).- Parameters:
methodDef
- The method to analyze.- Returns:
true
if the method is part of the latest scope definition and should be counted.
-
raiseCounter
private void raiseCounter(DetailAST method)
Determine the visibility modifier and raise the corresponding counter.- Parameters:
method
- The method-subtree from the AbstractSyntaxTree.
-
checkCounters
private void checkCounters(MethodCountCheck.MethodCounter counter, DetailAST ast)
Check the counters and report violations.- Parameters:
counter
- the method counters to checkast
- to report violations against.
-
checkMax
private void checkMax(int max, int value, String msg, DetailAST ast)
Utility for reporting if a maximum has been exceeded.- Parameters:
max
- the maximum allowed valuevalue
- the actual valuemsg
- the message to log. Takes two arguments of value and maximum.ast
- the AST to associate with the message.
-
setMaxPrivate
public void setMaxPrivate(int value)
Setter to specify the maximum number ofprivate
methods allowed.- Parameters:
value
- the maximum allowed.- Since:
- 5.3
-
setMaxPackage
public void setMaxPackage(int value)
Setter to specify the maximum number ofpackage
methods allowed.- Parameters:
value
- the maximum allowed.- Since:
- 5.3
-
setMaxProtected
public void setMaxProtected(int value)
Setter to specify the maximum number ofprotected
methods allowed.- Parameters:
value
- the maximum allowed.- Since:
- 5.3
-
setMaxPublic
public void setMaxPublic(int value)
Setter to specify the maximum number ofpublic
methods allowed.- Parameters:
value
- the maximum allowed.- Since:
- 5.3
-
setMaxTotal
public void setMaxTotal(int value)
Setter to specify the maximum number of methods allowed at all scope levels.- Parameters:
value
- the maximum allowed.- Since:
- 5.3
-
-