hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Fixed bug 2142986 - UselessOverridingMethod doesn't consider annotations

Browse Source 
new property 'ignoreAnnotations' to get the old behavior


git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/branches/pmd/4.2.x@6818 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
Xavier Le Vourch 2009-02-08 19:19:33 +00:00
parent 605de6f7bf
commit de924b50cf
4 changed files with 117 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
pmd/etc/changelog.txt
View File

@ -10,6 +10,7 @@ Fixed bug 2404700 - UseSingleton should not act on enums
Fixed bug 2225474 - VariableNamingConventions does not work with nonprimitives
Fixed bug 1609038 - Xslt report generators break if path contains "java"
Fixed bug - JUnitTestsShouldIncludeAssert now detects Junit 4 Assert.assert... constructs
Fixed bug 2142986 - UselessOverridingMethod doesn't consider annotations
New rule:
StrictExceptions : AvoidThrowingNewInstanceOfSameException

63
pmd/regress/test/net/sourceforge/pmd/rules/basic/xml/UselessOverridingMethod.xml
View File

@ -302,4 +302,67 @@ class Bar {
}
]]></code>
</test-code>
<test-code reinitializeRule="1">
<description>
<![CDATA[
[ 2142986 ] UselessOverridingMethod doesn't consider annotations, ignoreAnnotations property set to true
]]>
</description>
<rule-property name="ignoreAnnotations">true</rule-property>
<expected-problems>1</expected-problems>
<code>
<![CDATA[
class PersistentObject {
public Long getId() { return 1L; }
}
public class Example extends PersistentObject {
@Override
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
public Long getId() { return super.getId(); }
}
]]></code>
</test-code>
<test-code reinitializeRule="1">
<description>
<![CDATA[
[ 2142986 ] UselessOverridingMethod doesn't consider annotations
]]>
</description>
<expected-problems>0</expected-problems>
<code>
<![CDATA[
class PersistentObject {
public Long getId() { return 1L; }
}
public class Example extends PersistentObject {
@Override
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
public Long getId() { return super.getId(); }
}
]]></code>
</test-code>
<test-code reinitializeRule="1">
<description>
<![CDATA[
[ 2142986 ] UselessOverridingMethod doesn't consider annotations, @Override only
]]>
</description>
<expected-problems>1</expected-problems>
<code>
<![CDATA[
class PersistentObject {
public Long getId() { return 1L; }
}
public class Example extends PersistentObject {
@Override
public Long getId() { return super.getId(); }
}
]]></code>
</test-code>
</test-data>

9
pmd/rulesets/basic.xml
View File

@ -668,6 +668,9 @@ public class Foo {
The overriding method merely calls the same method defined in a superclass
</description>
<priority>3</priority>
<properties>
<property name="ignoreAnnotations" description="Ignore annotations" value="false"/>
</properties>
<example><![CDATA[
public void foo(String bar) {
super.foo(bar); //Why bother overriding?
@ -676,6 +679,12 @@ public void foo(String bar) {
<example><![CDATA[
public String foo() {
return super.foo(); //Why bother overriding?
}
]]></example>
<example><![CDATA[
@Id
public Long getId() {
return super.getId(); //OK if 'ignoreAnnotations' is false, which is the default behavior
}
]]></example>
</rule>

52
pmd/src/net/sourceforge/pmd/rules/UselessOverridingMethod.java
View File

@ -5,8 +5,11 @@ package net.sourceforge.pmd.rules;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import net.sourceforge.pmd.AbstractRule;
import net.sourceforge.pmd.PropertyDescriptor;
import net.sourceforge.pmd.ast.ASTAnnotation;
import net.sourceforge.pmd.ast.ASTArgumentList;
import net.sourceforge.pmd.ast.ASTArguments;
import net.sourceforge.pmd.ast.ASTBlock;
@ -15,6 +18,7 @@ import net.sourceforge.pmd.ast.ASTClassOrInterfaceDeclaration;
import net.sourceforge.pmd.ast.ASTFormalParameter;
import net.sourceforge.pmd.ast.ASTFormalParameters;
import net.sourceforge.pmd.ast.ASTImplementsList;
import net.sourceforge.pmd.ast.ASTMarkerAnnotation;
import net.sourceforge.pmd.ast.ASTMethodDeclaration;
import net.sourceforge.pmd.ast.ASTMethodDeclarator;
import net.sourceforge.pmd.ast.ASTName;
@ -27,6 +31,7 @@ import net.sourceforge.pmd.ast.ASTStatement;
import net.sourceforge.pmd.ast.ASTVariableDeclaratorId;
import net.sourceforge.pmd.ast.Node;
import net.sourceforge.pmd.ast.SimpleNode;
import net.sourceforge.pmd.properties.BooleanProperty;
import org.jaxen.JaxenException;
@ -34,25 +39,39 @@ import org.jaxen.JaxenException;
* @author Romain Pelisse, bugfix for [ 1522517 ] False +: UselessOverridingMethod
*/
public class UselessOverridingMethod extends AbstractRule {
private List<String> exceptions;
private static final String CLONE = "clone";
private static final String OBJECT = "Object";
public UselessOverridingMethod()
{
private final List<String> exceptions;
private boolean ignoreAnnotations;
private static final String CLONE = "clone";
private static final String OBJECT = "Object";
private static final PropertyDescriptor ignoreAnnotationsDescriptor = new BooleanProperty(
"ignoreAnnotations", "Ignore annotations", false, 1.0f);
private static final Map<String, PropertyDescriptor> propertyDescriptorsByName = asFixedMap(new PropertyDescriptor[] { ignoreAnnotationsDescriptor });
@Override
protected Map<String, PropertyDescriptor> propertiesByName() {
return propertyDescriptorsByName;
}
public UselessOverridingMethod() {
exceptions = new ArrayList<String>(1);
exceptions.add("CloneNotSupportedException");
}
}
public Object visit(ASTImplementsList clz, Object data)
@Override
public Object visit(ASTImplementsList clz, Object data)
{
return super.visit(clz,data);
}
@Override
public Object visit(ASTClassOrInterfaceDeclaration clz, Object data) {
if (clz.isInterface()) {
return data;
}
ignoreAnnotations = getBooleanProperty(ignoreAnnotationsDescriptor);
return super.visit(clz, data);
}
@ -106,6 +125,7 @@ public class UselessOverridingMethod extends AbstractRule {
return result;
}
@Override
public Object visit(ASTMethodDeclaration node, Object data) {
// Can skip abstract methods and methods whose only purpose is to
// guarantee that the inherited method is not changed by finalizing
@ -114,7 +134,7 @@ public class UselessOverridingMethod extends AbstractRule {
return super.visit(node, data);
}
// We can also skip the 'clone' method as they are generally
// 'useless' but as it is considered a 'good practise' to
// 'useless' but as it is considered a 'good practice' to
// implement them anyway ( see bug 1522517)
if ( CLONE.equals(node.getMethodName()) && node.isPublic() &&
! this.hasArguments(node) &&
@ -168,6 +188,22 @@ public class UselessOverridingMethod extends AbstractRule {
if (formalParameters.jjtGetNumChildren() != arguments.jjtGetNumChildren())
return super.visit(node, data);
if (!ignoreAnnotations) {
ASTClassOrInterfaceBodyDeclaration parent = (ASTClassOrInterfaceBodyDeclaration) node.jjtGetParent();
for (int i = 0; i < parent.jjtGetNumChildren(); i++) {
Node n = parent.jjtGetChild(i);
if (n instanceof ASTAnnotation) {
if (n.jjtGetChild(0) instanceof ASTMarkerAnnotation) {
// @Override is ignored
if ("Override".equals(((ASTName) n.jjtGetChild(0).jjtGetChild(0)).getImage())) {
continue;
}
}
return super.visit(node, data);
}
}
}
if (arguments.jjtGetNumChildren() == 0) //No arguments to check
addViolation(data, node, getMessage());
else {