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 or public). Each count is completely
separated to customize how many methods of each you want to allow. For example,
specifying a maxTotal of 10, still means you can prevent more than 0
maxPackage 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
}
}
maxTotal - Specify the maximum number of methods allowed at all scope levels.
Type is int.
Default value is 100.
maxPrivate - Specify the maximum number of private methods allowed.
Type is int.
Default value is 100.
maxPackage - Specify the maximum number of package methods allowed.
Type is int.
Default value is 100.
maxProtected - Specify the maximum number of protected methods allowed.
Type is int.
Default value is 100.
maxPublic - Specify the maximum number of public methods allowed.
Type is int.
Default value is 100.
tokens - tokens to check
Type is java.lang.String[].
Validation type is tokenSet.
Default value is:
CLASS_DEF,
ENUM_CONSTANT_DEF,
ENUM_DEF,
INTERFACE_DEF,
ANNOTATION_DEF,
RECORD_DEF.
To configure the default check:
<module name="MethodCount"/>
To configure the check to allow no more than 30 methods per type declaration:
<module name="MethodCount"> <property name="maxTotal" value="30"/> </module>
To configure the check to allow no more than 10 public methods per type declaration, and 40 methods in total:
<module name="MethodCount"> <property name="maxPublic" value="10"/> <property name="maxTotal" value="40"/> </module>
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
| Modifier and Type | Class and Description |
|---|---|
private static class |
MethodCountCheck.MethodCounter
Marker class used to collect data about the number of methods per
class.
|
AutomaticBean.OutputStreamOptions| Modifier and Type | Field and Description |
|---|---|
private java.util.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 of
package methods allowed. |
private int |
maxPrivate
Specify the maximum number of
private methods allowed. |
private int |
maxProtected
Specify the maximum number of
protected methods allowed. |
private int |
maxPublic
Specify the maximum number of
public methods allowed. |
private int |
maxTotal
Specify the maximum number of methods allowed at all scope levels.
|
static java.lang.String |
MSG_MANY_METHODS
A key is pointing to the warning message text in "messages.properties"
file.
|
static java.lang.String |
MSG_PACKAGE_METHODS
A key is pointing to the warning message text in "messages.properties"
file.
|
static java.lang.String |
MSG_PRIVATE_METHODS
A key is pointing to the warning message text in "messages.properties"
file.
|
static java.lang.String |
MSG_PROTECTED_METHODS
A key is pointing to the warning message text in "messages.properties"
file.
|
static java.lang.String |
MSG_PUBLIC_METHODS
A key is pointing to the warning message text in "messages.properties"
file.
|
| Constructor and Description |
|---|
MethodCountCheck() |
| Modifier and Type | Method and Description |
|---|---|
private void |
checkCounters(MethodCountCheck.MethodCounter counter,
DetailAST ast)
Check the counters and report violations.
|
private void |
checkMax(int max,
int value,
java.lang.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 of
package methods allowed. |
void |
setMaxPrivate(int value)
Setter to specify the maximum number of
private methods allowed. |
void |
setMaxProtected(int value)
Setter to specify the maximum number of
protected methods allowed. |
void |
setMaxPublic(int value)
Setter to specify the maximum number of
public 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.
|
beginTree, clearViolations, destroy, finishTree, getFileContents, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic static final java.lang.String MSG_PRIVATE_METHODS
public static final java.lang.String MSG_PACKAGE_METHODS
public static final java.lang.String MSG_PROTECTED_METHODS
public static final java.lang.String MSG_PUBLIC_METHODS
public static final java.lang.String MSG_MANY_METHODS
private static final int DEFAULT_MAX_METHODS
private final java.util.Deque<MethodCountCheck.MethodCounter> counters
private int maxPrivate
private methods allowed.private int maxPackage
package methods allowed.private int maxProtected
protected methods allowed.private int maxPublic
public methods allowed.private int maxTotal
public MethodCountCheck()
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 AbstractCheckast - the token to processpublic void leaveToken(DetailAST ast)
AbstractCheckleaveToken in class AbstractCheckast - the token leavingprivate boolean isInLatestScopeDefinition(DetailAST methodDef)
methodDef - The method to analyze.true if the method is part of the latest scope definition and should be
counted.private void raiseCounter(DetailAST method)
method - The method-subtree from the AbstractSyntaxTree.private void checkCounters(MethodCountCheck.MethodCounter counter, DetailAST ast)
counter - the method counters to checkast - to report violations against.private void checkMax(int max, int value, java.lang.String msg, DetailAST ast)
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.public void setMaxPrivate(int value)
private methods allowed.value - the maximum allowed.public void setMaxPackage(int value)
package methods allowed.value - the maximum allowed.public void setMaxProtected(int value)
protected methods allowed.value - the maximum allowed.public void setMaxPublic(int value)
public methods allowed.value - the maximum allowed.public void setMaxTotal(int value)
value - the maximum allowed.Copyright © 2001-2022. All Rights Reserved.