TouchInstinct
/
checkstyle
305
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Issue #2451: removed excess hierarchy from ReturnCountCheck

This commit is contained in:
rnveach 2015-10-29 16:15:33 -04:00 committed by Roman Ivanov
parent a172cb76e2
commit 32c3e506aa
3 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
config/suppressions.xml
View File

@ -37,7 +37,7 @@
files="AbstractClassNameCheckTest.java|AbstractTypeAwareCheckTest.java|AbstractJavadocCheckTest.java|AbstractViolationReporterTest.java"/>
<!-- Tone down the checking for test code -->
<suppress checks="CyclomaticComplexity" files="[\\/]XDocsPagesTest\.java" lines="320"/>
<suppress checks="CyclomaticComplexity" files="[\\/]XDocsPagesTest\.java" lines="319"/>
<suppress checks="EmptyBlock" files=".*[\\/]src[\\/]test[\\/]"/>
<suppress checks="ImportControl" files=".*[\\/]src[\\/](test|it)[\\/]"/>
<suppress checks="Javadoc" files=".*[\\/]src[\\/](test|it)[\\/]"/>

34
src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/ReturnCountCheck.java
View File

@ -21,10 +21,12 @@ package com.puppycrawl.tools.checkstyle.checks.coding;
import java.util.ArrayDeque;
import java.util.Deque;
import java.util.regex.Pattern;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
/**
* <p>
@ -38,7 +40,7 @@ import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
*
* @author <a href="mailto:simon@redhillconsulting.com.au">Simon Harris</a>
*/
public final class ReturnCountCheck extends AbstractFormatCheck {
public final class ReturnCountCheck extends Check {
/**
* A key is pointing to the warning message text in "messages.properties"
@ -46,22 +48,18 @@ public final class ReturnCountCheck extends AbstractFormatCheck {
*/
public static final String MSG_KEY = "return.count";
/** Default allowed number of return statements. */
private static final int DEFAULT_MAX = 2;
/** The format string of the regexp. */
private String format = "^equals$";
/** The regexp to match against. */
private Pattern regexp = Pattern.compile(format);
/** Stack of method contexts. */
private final Deque<Context> contextStack = new ArrayDeque<>();
/** Maximum allowed number of return stmts. */
private int max;
/** Maximum allowed number of return statements. */
private int max = 2;
/** Current method context. */
private Context context;
/** Creates new instance of the checks. */
public ReturnCountCheck() {
super("^equals$");
max = DEFAULT_MAX;
}
@Override
public int[] getDefaultTokens() {
return new int[] {
@ -89,6 +87,16 @@ public final class ReturnCountCheck extends AbstractFormatCheck {
};
}
/**
* Set the format to the specified regular expression.
* @param format a {@code String} value
* @throws org.apache.commons.beanutils.ConversionException unable to parse format
*/
public void setFormat(String format) {
this.format = format;
regexp = CommonUtils.createPattern(format);
}
/**
* Getter for max property.
* @return maximum allowed number of return statements.
@ -152,7 +160,7 @@ public final class ReturnCountCheck extends AbstractFormatCheck {
private void visitMethodDef(DetailAST ast) {
contextStack.push(context);
final DetailAST methodNameAST = ast.findFirstToken(TokenTypes.IDENT);
final boolean check = !getRegexp().matcher(methodNameAST.getText()).find();
final boolean check = !regexp.matcher(methodNameAST.getText()).find();
context = new Context(check);
}

1
src/test/java/com/puppycrawl/tools/checkstyle/XDocsPagesTest.java
View File

@ -111,7 +111,6 @@ public class XDocsPagesTest {
private static final List<String> UNDOCUMENTED_PROPERTIES = Arrays.asList(
"SuppressWithNearbyCommentFilter.fileContents",
"IllegalTokenTextCheck.compileFlags",
"ReturnCountCheck.compileFlags",
"MutableExceptionCheck.compileFlags",
"AbstractClassNameCheck.compileFlags",
"ClassTypeParameterNameCheck.compileFlags",