Class ReturnCountCheck
- 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.coding.ReturnCountCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public final class ReturnCountCheck extends AbstractCheck
Restricts the number of return statements in methods, constructors and lambda expressions (2 by default). Ignores specified methods (
equals()
by default).max property will only check returns in methods and lambdas that return a specific value (Ex: 'return 1;').
maxForVoid property will only check returns in methods, constructors, and lambdas that have no return type (IE 'return;'). It will only count visible return statements. Return statements not normally written, but implied, at the end of the method/constructor definition will not be taken into account. To disallow "return;" in void return type methods, use a value of 0.
Rationale: Too many return points can be indication that code is attempting to do too much or may be difficult to understand.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private class
ReturnCountCheck.Context
Class to encapsulate information about one method.
-
Field Summary
Fields Modifier and Type Field Description private ReturnCountCheck.Context
context
Current method context.private java.util.Deque<ReturnCountCheck.Context>
contextStack
Stack of method contexts.private java.util.regex.Pattern
format
The regexp to match against.private int
max
Maximum allowed number of return statements.private int
maxForVoid
Maximum allowed number of return statements for void methods.static java.lang.String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description ReturnCountCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
beginTree(DetailAST rootAST)
Called before the starting to process a tree.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 void
leave(DetailAST ast)
Checks number of return statements and restore previous context.void
leaveToken(DetailAST ast)
Called after all the child nodes have been process.void
setFormat(java.util.regex.Pattern pattern)
Set the format for the specified regular expression.void
setMax(int max)
Setter for max property.void
setMaxForVoid(int maxForVoid)
Setter for maxForVoid property.private void
visitLambda()
Creates new lambda context and places old one on the stack.private void
visitMethodDef(DetailAST ast)
Creates new method context and places old one on the stack.private void
visitReturn(DetailAST ast)
Examines the return statement and tells context about it.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, 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
-
-
-
-
Field Detail
-
MSG_KEY
public static final java.lang.String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
contextStack
private final java.util.Deque<ReturnCountCheck.Context> contextStack
Stack of method contexts.
-
format
private java.util.regex.Pattern format
The regexp to match against.
-
max
private int max
Maximum allowed number of return statements.
-
maxForVoid
private int maxForVoid
Maximum allowed number of return statements for void methods.
-
context
private ReturnCountCheck.Context context
Current method context.
-
-
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
-
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
-
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
-
setFormat
public void setFormat(java.util.regex.Pattern pattern)
Set the format for the specified regular expression.- Parameters:
pattern
- a pattern.
-
setMax
public void setMax(int max)
Setter for max property.- Parameters:
max
- maximum allowed number of return statements.
-
setMaxForVoid
public void setMaxForVoid(int maxForVoid)
Setter for maxForVoid property.- Parameters:
maxForVoid
- maximum allowed number of return statements for void methods.
-
beginTree
public void beginTree(DetailAST rootAST)
Description copied from class:AbstractCheck
Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.- Overrides:
beginTree
in classAbstractCheck
- Parameters:
rootAST
- the root of the tree
-
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
-
visitMethodDef
private void visitMethodDef(DetailAST ast)
Creates new method context and places old one on the stack.- Parameters:
ast
- method definition for check.
-
leave
private void leave(DetailAST ast)
Checks number of return statements and restore previous context.- Parameters:
ast
- node to leave.
-
visitLambda
private void visitLambda()
Creates new lambda context and places old one on the stack.
-
visitReturn
private void visitReturn(DetailAST ast)
Examines the return statement and tells context about it.- Parameters:
ast
- return statement to check.
-
-