Class LambdaBodyLengthCheck
- 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.LambdaBodyLengthCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class LambdaBodyLengthCheck extends AbstractCheck
Checks lambda body length.Rationale: Similar to anonymous inner classes, if lambda body becomes very long it is hard to understand and to see the flow of the method where the lambda is defined. Therefore, long lambda body should usually be extracted to method.
-
Property
max
- Specify the maximum number of lines allowed. Type isint
. Default value is10
.
Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
maxLen.lambdaBody
- Since:
- 8.37
-
-
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 static int
DEFAULT_MAX
Default maximum number of lines.private int
max
Specify the maximum number of lines allowed.static String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description LambdaBodyLengthCheck()
-
Method Summary
All Methods Static 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.private static int
getFirstNodeLineNumber(DetailAST lambdaBody)
Get first child node in the tree line number.private static int
getLastNodeLineNumber(DetailAST lambdaBody)
Get last child node in the tree line number.private static int
getLength(DetailAST ast)
Get length of lambda body.int[]
getRequiredTokens()
The tokens that this check must be registered for.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
-
-
-
-
Field Detail
-
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
private static final int DEFAULT_MAX
Default maximum number of lines.- See Also:
- Constant Field Values
-
max
private int max
Specify the maximum number of lines allowed.
-
-
Constructor Detail
-
LambdaBodyLengthCheck
public LambdaBodyLengthCheck()
-
-
Method Detail
-
setMax
public void setMax(int length)
Setter to specify the maximum number of lines allowed.- Parameters:
length
- the maximum length of lambda body.- Since:
- 8.37
-
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
-
getLength
private static int getLength(DetailAST ast)
Get length of lambda body.- Parameters:
ast
- lambda body node.- Returns:
- length of lambda body.
-
getLastNodeLineNumber
private static int getLastNodeLineNumber(DetailAST lambdaBody)
Get last child node in the tree line number.- Parameters:
lambdaBody
- lambda body node.- Returns:
- last child node in the tree line number.
-
getFirstNodeLineNumber
private static int getFirstNodeLineNumber(DetailAST lambdaBody)
Get first child node in the tree line number.- Parameters:
lambdaBody
- lambda body node.- Returns:
- first child node in the tree line number.
-
-