Package com.puppycrawl.tools.checkstyle.checks.sizes

Class MethodLengthCheck

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.MethodLengthCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class MethodLengthCheck
extends AbstractCheck

Checks for long methods and constructors.

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.

• Property countEmpty - Control whether to count empty lines and comments. Type is boolean. Default value is true.
• Property max - Specify the maximum number of lines allowed. Type is int. Default value is 150.
• Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: METHOD_DEF, CTOR_DEF, COMPACT_CTOR_DEF.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• maxLen.method

Since:

3.0

Nested Class Summary

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

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	countEmpty	Control whether to count empty lines and comments.
private static final int	DEFAULT_MAX_LINES	Default maximum number of lines.
private int	max	Specify the maximum number of lines allowed.
static final String	MSG_KEY	A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor	Description
MethodLengthCheck()

Method Summary

Modifier and Type	Method	Description
private static int	countUsedLines(DetailAST ast)	Count number of used code lines without comments.
int[]	getAcceptableTokens()	The configurable token set.
int[]	getDefaultTokens()	Returns the default token a check is interested in.
private static int	getLengthOfBlock(DetailAST openingBrace, DetailAST closingBrace)	Returns length of code.
int[]	getRequiredTokens()	The tokens that this check must be registered for.
void	setCountEmpty(boolean countEmpty)	Setter to control whether to count empty lines and comments.
void	setMax(int length)	Setter to specify the maximum number of lines allowed.
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

DEFAULT_MAX_LINES

private static final int DEFAULT_MAX_LINES

Default maximum number of lines.

See Also:

• Constant Field Values

countEmpty

private boolean countEmpty

Control whether to count empty lines and comments.

max

private int max

Specify the maximum number of lines allowed.

Constructor Details

MethodLengthCheck

public MethodLengthCheck()

Method Details

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

getLengthOfBlock

private static int getLengthOfBlock(DetailAST openingBrace,
 DetailAST closingBrace)

Returns length of code.

Parameters:

openingBrace - block opening brace

closingBrace - block closing brace

Returns:

number of lines with code for current block

countUsedLines

private static int countUsedLines(DetailAST ast)

Count number of used code lines without comments.

Parameters:

ast - start ast

Returns:

number of used lines of code

setMax

public void setMax(int length)

Setter to specify the maximum number of lines allowed.

Parameters:

length - the maximum length of a method.

Since:

3.0

setCountEmpty

public void setCountEmpty(boolean countEmpty)

Setter to control whether to count empty lines and comments.

Parameters:

countEmpty - whether to count empty and comments.

Since:

3.2