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

Issue #1566: File length of JavadocMethodCheck has been reduced

This commit is contained in:
Baratali Izmailov 2015-08-17 13:55:30 -04:00 committed by Roman Ivanov
parent f17f1410a5
commit b02dba99c5
2 changed files with 103 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

102
src/main/java/com/puppycrawl/tools/checkstyle/checks/CheckUtils.java
View File

@ -45,6 +45,15 @@ public final class CheckUtils {
/** hex radix */
private static final int BASE_16 = 16;
/** Maximum children allowed in setter/getter */
private static final int SETTER_GETTER_MAX_CHILDREN = 7;
/** Maximum nodes allowed in a body of setter */
private static final int SETTER_BODY_SIZE = 3;
/** Maximum nodes allowed in a body of getter */
private static final int GETTER_BODY_SIZE = 2;
/** prevent instances */
private CheckUtils() {
}
@ -305,4 +314,97 @@ public final class CheckUtils {
return typeParams;
}
/**
* Returns whether an AST represents a setter method.
* @param ast the AST to check with
* @return whether the AST represents a setter method
*/
public static boolean isSetterMethod(final DetailAST ast) {
// Check have a method with exactly 7 children which are all that
// is allowed in a proper setter method which does not throw any
// exceptions.
if (ast.getType() != TokenTypes.METHOD_DEF
|| ast.getChildCount() != SETTER_GETTER_MAX_CHILDREN) {
return false;
}
// Should I handle only being in a class????
// Check the name matches format setX...
final DetailAST type = ast.findFirstToken(TokenTypes.TYPE);
final String name = type.getNextSibling().getText();
if (!name.matches("^set[A-Z].*")) { // Depends on JDK 1.4
return false;
}
// Check the return type is void
if (type.getChildCount(TokenTypes.LITERAL_VOID) == 0) {
return false;
}
// Check that is had only one parameter
final DetailAST params = ast.findFirstToken(TokenTypes.PARAMETERS);
if (params.getChildCount(TokenTypes.PARAMETER_DEF) != 1) {
return false;
}
// Now verify that the body consists of:
// SLIST -> EXPR -> ASSIGN
// SEMI
// RCURLY
final DetailAST slist = ast.findFirstToken(TokenTypes.SLIST);
if (slist == null || slist.getChildCount() != SETTER_BODY_SIZE) {
return false;
}
final DetailAST expr = slist.getFirstChild();
return expr.getFirstChild().getType() == TokenTypes.ASSIGN;
}
/**
* Returns whether an AST represents a getter method.
* @param ast the AST to check with
* @return whether the AST represents a getter method
*/
public static boolean isGetterMethod(final DetailAST ast) {
// Check have a method with exactly 7 children which are all that
// is allowed in a proper getter method which does not throw any
// exceptions.
if (ast.getType() != TokenTypes.METHOD_DEF
|| ast.getChildCount() != SETTER_GETTER_MAX_CHILDREN) {
return false;
}
// Check the name matches format of getX or isX. Technically I should
// check that the format isX is only used with a boolean type.
final DetailAST type = ast.findFirstToken(TokenTypes.TYPE);
final String name = type.getNextSibling().getText();
if (!name.matches("^(is|get)[A-Z].*")) { // Depends on JDK 1.4
return false;
}
// Check the return type is void
if (type.getChildCount(TokenTypes.LITERAL_VOID) > 0) {
return false;
}
// Check that is had only one parameter
final DetailAST params = ast.findFirstToken(TokenTypes.PARAMETERS);
if (params.getChildCount(TokenTypes.PARAMETER_DEF) > 0) {
return false;
}
// Now verify that the body consists of:
// SLIST -> RETURN
// RCURLY
final DetailAST slist = ast.findFirstToken(TokenTypes.SLIST);
if (slist == null || slist.getChildCount() != GETTER_BODY_SIZE) {
return false;
}
final DetailAST expr = slist.getFirstChild();
return expr.getType() == TokenTypes.LITERAL_RETURN;
}
}

103
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java
View File

@ -28,8 +28,6 @@ import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import antlr.collections.AST;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.ScopeUtils;
@ -129,12 +127,6 @@ public class JavadocMethodCheck extends AbstractTypeAwareCheck {
private static final Pattern MATCH_JAVADOC_NOARG_CURLY =
Utils.createPattern("\\{\\s*@(inheritDoc)\\s*\\}");
/** Maximum children allowed * */
private static final int MAX_CHILDREN = 7;
/** Maximum children allowed * */
private static final int BODY_SIZE = 3;
/** Default value of minimal amount of lines in method to demand documentation presence.*/
private static final int DEFAULT_MIN_LINE_COUNT = -1;
@ -436,7 +428,7 @@ public class JavadocMethodCheck extends AbstractTypeAwareCheck {
protected boolean isMissingJavadocAllowed(final DetailAST ast) {
return allowMissingJavadoc
|| allowMissingPropertyJavadoc
&& (isSetterMethod(ast) || isGetterMethod(ast))
&& (CheckUtils.isSetterMethod(ast) || CheckUtils.isGetterMethod(ast))
|| matchesSkipRegex(ast);
}
@ -927,99 +919,6 @@ public class JavadocMethodCheck extends AbstractTypeAwareCheck {
}
}
/**
* Returns whether an AST represents a setter method.
* @param ast the AST to check with
* @return whether the AST represents a setter method
*/
private static boolean isSetterMethod(final DetailAST ast) {
// Check have a method with exactly 7 children which are all that
// is allowed in a proper setter method which does not throw any
// exceptions.
if (ast.getType() != TokenTypes.METHOD_DEF
|| ast.getChildCount() != MAX_CHILDREN) {
return false;
}
// Should I handle only being in a class????
// Check the name matches format setX...
final DetailAST type = ast.findFirstToken(TokenTypes.TYPE);
final String name = type.getNextSibling().getText();
if (!name.matches("^set[A-Z].*")) { // Depends on JDK 1.4
return false;
}
// Check the return type is void
if (type.getChildCount(TokenTypes.LITERAL_VOID) == 0) {
return false;
}
// Check that is had only one parameter
final DetailAST params = ast.findFirstToken(TokenTypes.PARAMETERS);
if (params.getChildCount(TokenTypes.PARAMETER_DEF) != 1) {
return false;
}
// Now verify that the body consists of:
// SLIST -> EXPR -> ASSIGN
// SEMI
// RCURLY
final DetailAST slist = ast.findFirstToken(TokenTypes.SLIST);
if (slist == null || slist.getChildCount() != BODY_SIZE) {
return false;
}
final AST expr = slist.getFirstChild();
return expr.getFirstChild().getType() == TokenTypes.ASSIGN;
}
/**
* Returns whether an AST represents a getter method.
* @param ast the AST to check with
* @return whether the AST represents a getter method
*/
private static boolean isGetterMethod(final DetailAST ast) {
// Check have a method with exactly 7 children which are all that
// is allowed in a proper getter method which does not throw any
// exceptions.
if (ast.getType() != TokenTypes.METHOD_DEF
|| ast.getChildCount() != MAX_CHILDREN) {
return false;
}
// Check the name matches format of getX or isX. Technically I should
// check that the format isX is only used with a boolean type.
final DetailAST type = ast.findFirstToken(TokenTypes.TYPE);
final String name = type.getNextSibling().getText();
if (!name.matches("^(is|get)[A-Z].*")) { // Depends on JDK 1.4
return false;
}
// Check the return type is void
if (type.getChildCount(TokenTypes.LITERAL_VOID) > 0) {
return false;
}
// Check that is had only one parameter
final DetailAST params = ast.findFirstToken(TokenTypes.PARAMETERS);
if (params.getChildCount(TokenTypes.PARAMETER_DEF) > 0) {
return false;
}
// Now verify that the body consists of:
// SLIST -> RETURN
// RCURLY
final DetailAST slist = ast.findFirstToken(TokenTypes.SLIST);
if (slist == null || slist.getChildCount() != 2) {
return false;
}
final AST expr = slist.getFirstChild();
return expr.getType() == TokenTypes.LITERAL_RETURN;
}
/** Stores useful information about declared exception. */
private static class ExceptionInfo {
/** does the exception have throws tag associated with. */