Class MethodCountCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- 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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description 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 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
leaveToken(DetailAST ast)
Called after all the child nodes have been process.void
setMaxPackage(int value)
Sets the maximum allowedpackage
methods per type.void
setMaxPrivate(int value)
Sets the maximum allowedprivate
methods per type.void
setMaxProtected(int value)
Sets the maximum allowedprotected
methods per type.void
setMaxPublic(int value)
Sets the maximum allowedpublic
methods per type.void
setMaxTotal(int value)
Sets the maximum total methods per type.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, log, log, log, setClassLoader, 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.api.AutomaticBean
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
-
-
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
-
setMaxPrivate
public void setMaxPrivate(int value)
Sets the maximum allowedprivate
methods per type.- Parameters:
value
- the maximum allowed.
-
setMaxPackage
public void setMaxPackage(int value)
Sets the maximum allowedpackage
methods per type.- Parameters:
value
- the maximum allowed.
-
setMaxProtected
public void setMaxProtected(int value)
Sets the maximum allowedprotected
methods per type.- Parameters:
value
- the maximum allowed.
-
setMaxPublic
public void setMaxPublic(int value)
Sets the maximum allowedpublic
methods per type.- Parameters:
value
- the maximum allowed.
-
setMaxTotal
public void setMaxTotal(int value)
Sets the maximum total methods per type.- Parameters:
value
- the maximum allowed.
-
-