com.puppycrawl.tools.checkstyle.checks.sizes

Class MethodLengthCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class MethodLengthCheck
extends Check

Checks for long methods.

Rationale: If a method becomes very long it is hard to understand. Therefore long methods should usually be refactored into several individual methods that focus on a specific task.

The default maximum method length is 150 lines. To change the maximum number of lines, set property max.

An example of how to configure the check is:

 <module name="MethodLength"/>
 

An example of how to configure the check so that it accepts methods with at most 60 lines is:

 <module name="MethodLength">
    <property name="max" value="60"/>
 </module>
 

Author:

Lars Kühne

Constructor Summary

Constructors

Constructor and Description
MethodLengthCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultTokens() Returns the default token a check is interested in.
void	setCountEmpty(boolean countEmpty)
void	setMax(int length)
void	visitToken(DetailAST ast) Called to process a token.

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodLengthCheck

public MethodLengthCheck()

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

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 Check

Returns:

the default tokens

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process

setMax

public void setMax(int length)

Parameters:

length - the maximum length of a method.

setCountEmpty

public void setCountEmpty(boolean countEmpty)

Parameters:

countEmpty - whether to count empty and single line comments of the form //.