[java] Property ignoredAnnotations does not work for SingularField and ImmutableField

Fixes #1056

docs/pages/release_notes.md

@@ -137,6 +137,8 @@ from the comunity during the processm but if you have a legitimate use case for
 *   java-codestyle
     *   [#1003](https://github.com/pmd/pmd/issues/1003): \[java] UnnecessaryConstructor triggered on required empty constructor (Dagger @Inject)
     *   [#1023](https://github.com/pmd/pmd/issues/1023): \[java] False positive for useless parenthesis
+*   java-design
+    *   [#1056](https://github.com/pmd/pmd/issues/1056): \[java] Property ignoredAnnotations does not work for SingularField and ImmutableField
 *   java-errorprone
     *   [#629](https://github.com/pmd/pmd/issues/629): \[java] NullAssignment false positive
     *   [#816](https://github.com/pmd/pmd/issues/816): \[java] SingleMethodSingleton false positives with inner classes

pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/ImmutableFieldRule.java

@@ -23,6 +23,7 @@ import net.sourceforge.pmd.lang.java.ast.ASTTryStatement;
 import net.sourceforge.pmd.lang.java.ast.ASTVariableInitializer;
 import net.sourceforge.pmd.lang.java.ast.ASTWhileStatement;
 import net.sourceforge.pmd.lang.java.ast.AccessNode;
+import net.sourceforge.pmd.lang.java.ast.Annotatable;
 import net.sourceforge.pmd.lang.java.rule.AbstractLombokAwareRule;
 import net.sourceforge.pmd.lang.java.symboltable.JavaNameOccurrence;
 import net.sourceforge.pmd.lang.java.symboltable.VariableNameDeclaration;
@@ -54,7 +55,8 @@ public class ImmutableFieldRule extends AbstractLombokAwareRule {
             AccessNode accessNodeParent = field.getAccessNodeParent();
             if (accessNodeParent.isStatic() || !accessNodeParent.isPrivate() || accessNodeParent.isFinal()
                     || accessNodeParent.isVolatile()
-                    || hasClassLombokAnnotation()) {
+                    || hasClassLombokAnnotation()
+                    || hasIgnoredAnnotation((Annotatable) accessNodeParent)) {
                 continue;
             }
 

pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/SingularFieldRule.java

@@ -51,7 +51,7 @@ public class SingularFieldRule extends AbstractLombokAwareRule {
         boolean checkInnerClasses = getProperty(CHECK_INNER_CLASSES);
         boolean disallowNotAssignment = getProperty(DISALLOW_NOT_ASSIGNMENT);
 
-        if (node.isPrivate() && !node.isStatic() && !hasClassLombokAnnotation() && !hasLombokAnnotation(node)) {
+        if (node.isPrivate() && !node.isStatic() && !hasClassLombokAnnotation() && !hasIgnoredAnnotation(node)) {
             for (ASTVariableDeclarator declarator : node.findChildrenOfType(ASTVariableDeclarator.class)) {
                 ASTVariableDeclaratorId declaration = (ASTVariableDeclaratorId) declarator.jjtGetChild(0);
                 List<NameOccurrence> usages = declaration.getUsages();

pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/bestpractices/xml/UnusedPrivateMethod.xml

@@ -1579,4 +1579,28 @@ class Foo {
 }
      ]]></code>
     </test-code>
+
+    <test-code>
+        <description>Verify property ignoredAnnotations is used</description>
+        <rule-property name="ignoredAnnotations">java.lang.Override</rule-property>
+        <expected-problems>0</expected-problems>
+        <code><![CDATA[
+public class Foo {
+    @Override // well override doesn't really make sense, but it's good enough for the test case
+    private void foo() {}
+}
+        ]]></code>
+    </test-code>
+
+    <test-code>
+        <description>Verify property ignoredAnnotations is used - 2</description>
+        <rule-property name="ignoredAnnotations"></rule-property>
+        <expected-problems>1</expected-problems>
+        <code><![CDATA[
+public class Foo {
+    @Deprecated
+    private void foo() {}
+}
+        ]]></code>
+    </test-code>
 </test-data>

pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/codestyle/xml/UnnecessaryConstructor.xml

@@ -216,4 +216,17 @@ public enum Foo {
 }
      ]]></code>
     </test-code>
+
+    <test-code>
+        <description>Verify ignoredAnnotations property is used</description>
+        <rule-property name="ignoredAnnotations">java.lang.Deprecated</rule-property>
+        <expected-problems>0</expected-problems>
+        <code><![CDATA[
+public class Foo {
+    @Deprecated
+    public Foo() {
+    }
+}
+        ]]></code>
+    </test-code>
 </test-data>

pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/design/xml/ImmutableField.xml

@@ -466,4 +466,20 @@
             }
             ]]></code>
     </test-code>
+
+    <test-code>
+        <description>#1056 [java] Property ignoredAnnotations does not work for SingularField and ImmutableField</description>
+        <rule-property name="ignoredAnnotations">java.lang.Deprecated</rule-property>
+        <expected-problems>0</expected-problems>
+        <code><![CDATA[
+public class Foo {
+    @Deprecated
+    private int x;
+
+    public Foo() {
+        x = 2;
+    }
+}
+        ]]></code>
+    </test-code>
 </test-data>

pmd-java/src/test/resources/net/sourceforge/pmd/lang/java/rule/design/xml/SingularField.xml

@@ -628,4 +628,20 @@ public enum Foo {
         ]]></code>
     </test-code>
 
+    <test-code>
+        <description>#1056 [java] Property ignoredAnnotations does not work for SingularField and ImmutableField</description>
+        <rule-property name="ignoredAnnotations">java.lang.Deprecated</rule-property>
+        <expected-problems>0</expected-problems>
+        <code><![CDATA[
+public class Source {
+    @Deprecated
+    private Object o; //violation!
+
+    Object m() {
+        o = new Object();
+        return o;
+    }
+}
+        ]]></code>
+    </test-code>
 </test-data>