Issue #13213: Remove '//ok' comments from equalshashcode

checkstyle · Feb 17, 2024 · 0723bc1 · 0723bc1
1 parent cf6a9d5
commit 0723bc1
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 63 deletions.
diff --git a/config/checkstyle-input-suppressions.xml b/config/checkstyle-input-suppressions.xml
@@ -72,48 +72,6 @@
             files="checks[\\/]coding[\\/]avoidinlineconditionals[\\/]InputAvoidInlineConditionals.java"/>
   <suppress id="UnnecessaryOkComment"
             files="checks[\\/]coding[\\/]avoidinlineconditionals[\\/]InputAvoidInlineConditionals.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCode.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCode.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCode.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCode.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCode.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCode.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCode.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCode.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCode.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeEqualsParameter.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeEqualsParameter.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeEqualsParameter.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeEqualsParameter.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeEqualsParameter.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeEqualsParameter.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeEqualsParameter.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeEqualsParameter.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeSemantic.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeSemantic.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeSemantic.java"/>
-  <suppress id="UnnecessaryOkComment"
-            files="checks[\\/]coding[\\/]equalshashcode[\\/]InputEqualsHashCodeSemantic.java"/>
   <suppress id="UnnecessaryOkComment"
             files="checks[\\/]coding[\\/]illegalthrows[\\/]InputIllegalThrowsIgnoreMethodNames.java"/>
   <suppress id="UnnecessaryOkComment"

diff --git a/...ces/com/puppycrawl/tools/checkstyle/checks/coding/equalshashcode/InputEqualsHashCode.java b/...ces/com/puppycrawl/tools/checkstyle/checks/coding/equalshashcode/InputEqualsHashCode.java
@@ -6,40 +6,40 @@
 
 package com.puppycrawl.tools.checkstyle.checks.coding.equalshashcode;
 
-public class InputEqualsHashCode { // ok
-    public boolean notEquals() { // ok
+public class InputEqualsHashCode {
+    public boolean notEquals() {
         return true;
     }
 
-    public boolean equals() { // ok
+    public boolean equals() {
         return false;
     }
 
-    public boolean equals(Object o1) { // ok
+    public boolean equals(Object o1) {
         return false;
     }
 
     private boolean equals(Object o1, Object o2) {
         return false;
     }
 
-    private boolean equals(String s) { // ok
+    private boolean equals(String s) {
         return false;
     }
 
-    protected int notHashCode() { // ok
+    protected int notHashCode() {
         return 1;
     }
 
-    public int hashCode() { // ok
+    public int hashCode() {
         return 1;
     }
 
-    public int hashCode(Object o1) { // ok
+    public int hashCode(Object o1) {
         return 1;
     }
 
-    private int hashCode(Object o1, Object o2) { // ok
+    private int hashCode(Object o1, Object o2) {
         return 1;
     }
 }
diff --git a/...awl/tools/checkstyle/checks/coding/equalshashcode/InputEqualsHashCodeEqualsParameter.java b/...awl/tools/checkstyle/checks/coding/equalshashcode/InputEqualsHashCodeEqualsParameter.java
@@ -7,7 +7,7 @@
 package com.puppycrawl.tools.checkstyle.checks.coding.equalshashcode;
 
 public class InputEqualsHashCodeEqualsParameter {
-    public static class TestClass1 { // ok
+    public static class TestClass1 {
         public boolean equals(String o) {
             return true;
         }
@@ -28,7 +28,7 @@ public boolean equals(String o) {
             return false;
         }
     }
-    public static class TestClass4 { // ok
+    public static class TestClass4 {
         public int hashCode() {
             return 1;
         }
@@ -39,7 +39,7 @@ public boolean equals(String o) {
             return false;
         }
     }
-    public static class TestClass5 { // ok
+    public static class TestClass5 {
         public int hashCode() {
             return 1;
         }
@@ -63,7 +63,7 @@ public static boolean equals(Object o, Object o2) {
             return true;
         }
     }
-    public static class TestClass8 { // ok
+    public static class TestClass8 {
         public native int hashCode();
         public native boolean equals(Object o);
     }
@@ -73,7 +73,7 @@ public static class TestClass9 { // violation, no `equals` implementation
     public static class TestClass10 { // violation, no `hashCode` implementation
         public native boolean equals(Object o); // violation 'without .* of 'hashCode()'.'
     }
-    public static abstract class TestClass11 { // ok
+    public static abstract class TestClass11 {
         public abstract int hashCode();
         public abstract boolean equals(Object o);
     }
@@ -89,14 +89,14 @@ public boolean equals(java.lang.Object o) { // violation 'without .* of 'hashCod
             return true;
         }
     }
-    public interface TestClass14 { // ok
+    public interface TestClass14 {
         public int hashCode();
         public boolean equals(Object o);
     }
-    public interface TestClass15 { // ok
+    public interface TestClass15 {
         public boolean equals(Object o);
     }
-    public interface TestClass16 { // ok
+    public interface TestClass16 {
         public int hashCode();
     }
     public class TestClass17 {

diff --git a/...puppycrawl/tools/checkstyle/checks/coding/equalshashcode/InputEqualsHashCodeSemantic.java b/...puppycrawl/tools/checkstyle/checks/coding/equalshashcode/InputEqualsHashCodeSemantic.java
@@ -56,15 +56,15 @@ public boolean equals(int a) // wrong arg type, ok
 
     public class EqualsVsHashCode2
     {
-        public boolean equals(String a) // ok
+        public boolean equals(String a)
         {
             return true;
         }
     }
 
     public class EqualsVsHashCode3
     {
-        public boolean equals(Object a) // ok
+        public boolean equals(Object a)
         {
             return true;
         }
@@ -80,7 +80,7 @@ public class EqualsVsHashCode4
         // in anon inner class
         ByteArrayOutputStream bos1 = new ByteArrayOutputStream()
         {
-            public boolean equals(Object a) // ok
+            public boolean equals(Object a)
             {
                 return true;
             }
@@ -121,7 +121,7 @@ public <A> boolean equals(int a) // wrong arg type, ok even with generics
 
     public class EqualsVsHashCode6
     {
-        public <A> boolean equals(Comparable<A> a) // ok
+        public <A> boolean equals(Comparable<A> a)
         {
             return true;
         }