SONARJAVA-4448 S2437: Rephrase issue message to not use "silly" (#4535)

SonarSource · Nov 15, 2023 · 15b708d · 15b708d
1 parent 71f5cb1
commit 15b708d
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 14 deletions.
diff --git a/...n/java/checks/SillyBitOperationCheck.java → .../checks/UnnecessaryBitOperationCheck.java b/...n/java/checks/SillyBitOperationCheck.java → .../checks/UnnecessaryBitOperationCheck.java
@@ -1,16 +1,16 @@
 package checks;
 
-class SillyBitOperationCheck {
+class UnnecessaryBitOperationCheck {
   private void foo() {
     int result;
     int bitMask = 0x000F;
 
-    result = bitMask & -1; // Noncompliant {{Remove this silly bit operation.}}
-    result = bitMask | 0;  // Noncompliant [[sc=22;ec=23]] {{Remove this silly bit operation.}}
-    result = bitMask ^ 0;  // Noncompliant {{Remove this silly bit operation.}}
-    result &= -1; // Noncompliant [[sc=12;ec=14]] {{Remove this silly bit operation.}}
-    result |= 0;  // Noncompliant {{Remove this silly bit operation.}}
-    result ^= 0;  // Noncompliant {{Remove this silly bit operation.}}
+    result = bitMask & -1; // Noncompliant {{Remove this unnecessary bit operation.}}
+    result = bitMask | 0;  // Noncompliant [[sc=22;ec=23]] {{Remove this unnecessary bit operation.}}
+    result = bitMask ^ 0;  // Noncompliant {{Remove this unnecessary bit operation.}}
+    result &= -1; // Noncompliant [[sc=12;ec=14]] {{Remove this unnecessary bit operation.}}
+    result |= 0;  // Noncompliant {{Remove this unnecessary bit operation.}}
+    result ^= 0;  // Noncompliant {{Remove this unnecessary bit operation.}}
 
     result = bitMask & 1; // Compliant
     result = bitMask | 1; // compliant
@@ -21,7 +21,7 @@ private void foo() {
 
     long bitMaskLong = 0x000F;
     long resultLong;
-    resultLong = bitMaskLong & -1l; // Noncompliant {{Remove this silly bit operation.}}
+    resultLong = bitMaskLong & -1l; // Noncompliant {{Remove this unnecessary bit operation.}}
     resultLong = bitMaskLong & 0L; // Compliant
     resultLong = bitMaskLong & returnLong(); // Compliant
     resultLong = bitMaskLong & 0x0F; // Compliant

diff --git a/java-checks/src/main/java/org/sonar/java/checks/CheckList.java b/java-checks/src/main/java/org/sonar/java/checks/CheckList.java
@@ -612,7 +612,7 @@ public final class CheckList {
     ServletInstanceFieldCheck.class,
     ServletMethodsExceptionsThrownCheck.class,
     ShiftOnIntOrLongCheck.class,
-    SillyBitOperationCheck.class,
+    UnnecessaryBitOperationCheck.class,
     SillyEqualsCheck.class,
     SillyStringOperationsCheck.class,
     SimpleClassNameCheck.class,

diff --git a/...r/java/checks/SillyBitOperationCheck.java → .../checks/UnnecessaryBitOperationCheck.java b/...r/java/checks/SillyBitOperationCheck.java → .../checks/UnnecessaryBitOperationCheck.java
@@ -33,7 +33,7 @@
 import java.util.List;
 
 @Rule(key = "S2437")
-public class SillyBitOperationCheck extends IssuableSubscriptionVisitor {
+public class UnnecessaryBitOperationCheck extends IssuableSubscriptionVisitor {
 
   @Override
   public List<Kind> nodesToVisit() {
@@ -61,7 +61,7 @@ public void visitNode(Tree tree) {
     }
     Long evaluatedExpression = LiteralUtils.longLiteralValue(expression);
     if (evaluatedExpression != null && getBitwiseOperationIdentityElement(tree).equals(evaluatedExpression)) {
-      reportIssue(operatorToken, "Remove this silly bit operation.");
+      reportIssue(operatorToken, "Remove this unnecessary bit operation.");
     }
   }
 

diff --git a/...va/checks/SillyBitOperationCheckTest.java → ...cks/UnnecessaryBitOperationCheckTest.java b/...va/checks/SillyBitOperationCheckTest.java → ...cks/UnnecessaryBitOperationCheckTest.java
@@ -24,13 +24,13 @@
 
 import static org.sonar.java.checks.verifier.TestUtils.mainCodeSourcesPath;
 
-class SillyBitOperationCheckTest {
+class UnnecessaryBitOperationCheckTest {
 
   @Test
   void test() {
     CheckVerifier.newVerifier()
-      .onFile(mainCodeSourcesPath("checks/SillyBitOperationCheck.java"))
-      .withCheck(new SillyBitOperationCheck())
+      .onFile(mainCodeSourcesPath("checks/UnnecessaryBitOperationCheck.java"))
+      .withCheck(new UnnecessaryBitOperationCheck())
       .verifyIssues();
   }
 }