phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor InvalidSlf4jMessageFormatRule

Browse Source
This commit is contained in:
Andreas Dangel
2016-08-07 11:59:36 +02:00
parent cd9a8186db
commit c8a9f43ee0
1 changed files with 28 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/logging/InvalidSlf4jMessageFormatRule.java
View File

@ -6,11 +6,12 @@ package net.sourceforge.pmd.lang.java.rule.logging;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import org.apache.commons.lang3.StringUtils;
import net.sourceforge.pmd.lang.java.ast.ASTArgumentList;
import net.sourceforge.pmd.lang.java.ast.ASTClassOrInterfaceBody;
import net.sourceforge.pmd.lang.java.ast.ASTClassOrInterfaceType;
@ -29,8 +30,6 @@ import net.sourceforge.pmd.lang.java.rule.AbstractJavaRule;
import net.sourceforge.pmd.lang.java.symboltable.VariableNameDeclaration;
import net.sourceforge.pmd.lang.symboltable.NameDeclaration;
import org.apache.commons.lang3.StringUtils;
public class InvalidSlf4jMessageFormatRule extends AbstractJavaRule {
private static final Set<String> LOGGER_LEVELS;
@ -104,42 +103,53 @@ public class InvalidSlf4jMessageFormatRule extends AbstractJavaRule {
return super.visit(node, data);
}
private void removeThrowableParam(final List<ASTPrimaryExpression> params) {
// Throwable parameters are the last one in the list, if any.
if (params.isEmpty())
return;
int lastIndex = params.size() - 1;
ASTPrimaryExpression last = params.get(lastIndex);
private boolean isNewThrowable(ASTPrimaryExpression last) {
// in case a new exception is created or the exception class is mentioned.
ASTClassOrInterfaceType classOrInterface = last.getFirstDescendantOfType(ASTClassOrInterfaceType.class);
if (classOrInterface != null && classOrInterface.getType() != null
&& Throwable.class.isAssignableFrom(classOrInterface.getType())) {
params.remove(lastIndex);
return;
return true;
}
return false;
}
private boolean hasTypeThrowable(ASTPrimaryExpression last) {
// if the type could be determined already
if (last.getType() != null && Throwable.class.isAssignableFrom(last.getType())) {
params.remove(lastIndex);
return;
return true;
}
return false;
}
private boolean isReferencingThrowable(ASTPrimaryExpression last) {
// check the variable type, if there is a reference by name
ASTName variable = last.getFirstDescendantOfType(ASTName.class);
if (variable != null && variable.getNameDeclaration() != null
&& variable.getNameDeclaration() instanceof VariableNameDeclaration) {
VariableNameDeclaration declaration = (VariableNameDeclaration) variable.getNameDeclaration();
if (declaration.getType() != null && Throwable.class.isAssignableFrom(declaration.getType())) {
params.remove(lastIndex);
return;
return true;
}
// convention: Exception type names should end with Exception
if (declaration.getTypeImage() != null && declaration.getTypeImage().endsWith("Exception")) {
params.remove(lastIndex);
return;
return true;
}
}
return false;
}
private void removeThrowableParam(final List<ASTPrimaryExpression> params) {
// Throwable parameters are the last one in the list, if any.
if (params.isEmpty()) {
return;
}
int lastIndex = params.size() - 1;
ASTPrimaryExpression last = params.get(lastIndex);
if (isNewThrowable(last) || hasTypeThrowable(last) || isReferencingThrowable(last)) {
params.remove(lastIndex);
return;
}
}
private String getExpectedMessage(final List<ASTPrimaryExpression> params, final int expectedArguments) {