SONARJAVA-4912 S6204 Update issue message

SonarSource · Mar 18, 2024 · 0678be8 · 0678be8
1 parent 2c9f174
commit 0678be8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/java-checks-test-sources/default/src/main/java/checks/CollectorsToListCheckSample.java b/java-checks-test-sources/default/src/main/java/checks/CollectorsToListCheckSample.java
@@ -18,19 +18,19 @@ static class ListWrapper {
 
   void noncompliant() {
     List<String> list1 = Stream.of("A", "B", "C")
-      .collect(Collectors.toList()); // Noncompliant [[sc=16;ec=35]] {{Replace this usage of 'Stream.collect(Collectors.toList())' with 'Stream.toList()'}}
+      .collect(Collectors.toList()); // Noncompliant [[sc=16;ec=35]] {{Replace this usage of 'Stream.collect(Collectors.toList())' with 'Stream.toList()' and ensure that the list is unmodified.}}
 
     // Not modifying the list
     list1.contains("B");
 
     List<String> list2 = Stream.of("A", "B", "C")
-      .collect(Collectors.toUnmodifiableList()); // Noncompliant [[sc=16;ec=47]] {{Replace this usage of 'Stream.collect(Collectors.toUnmodifiableList())' with 'Stream.toList()'}}
+      .collect(Collectors.toUnmodifiableList()); // Noncompliant [[sc=16;ec=47]] {{Replace this usage of 'Stream.collect(Collectors.toUnmodifiableList())' with 'Stream.toList()'.}}
 
     Stream.of("A", "B", "C")
-      .collect(Collectors.toList()); // Noncompliant [[sc=16;ec=35]] {{Replace this usage of 'Stream.collect(Collectors.toList())' with 'Stream.toList()'}}
+      .collect(Collectors.toList()); // Noncompliant [[sc=16;ec=35]] {{Replace this usage of 'Stream.collect(Collectors.toList())' with 'Stream.toList()' and ensure that the list is unmodified.}}
 
     Stream.of("A", "B", "C")
-      .collect(Collectors.toUnmodifiableList()); // Noncompliant [[sc=16;ec=47]] {{Replace this usage of 'Stream.collect(Collectors.toUnmodifiableList())' with 'Stream.toList()'}}
+      .collect(Collectors.toUnmodifiableList()); // Noncompliant [[sc=16;ec=47]] {{Replace this usage of 'Stream.collect(Collectors.toUnmodifiableList())' with 'Stream.toList()'.}}
 
     List<List<String>> listOfLists = new ArrayList<>();
     // list1 appears in a call to List.add, but it is not the receiver, so it should not be interpreted as mutable:

diff --git a/java-checks/src/main/java/org/sonar/java/checks/CollectorsToListCheck.java b/java-checks/src/main/java/org/sonar/java/checks/CollectorsToListCheck.java
@@ -38,7 +38,7 @@
 
 @Rule(key = "S6204")
 public class CollectorsToListCheck extends AbstractMethodDetection implements JavaVersionAwareVisitor {
-  private static final String MESSAGE = "Replace this usage of 'Stream.collect(Collectors.%s())' with 'Stream.toList()'";
+  private static final String MESSAGE = "Replace this usage of 'Stream.collect(Collectors.%s())' with 'Stream.toList()'%s.";
 
   private static final MethodMatchers COLLECT = MethodMatchers.create()
     .ofSubTypes("java.util.stream.Stream")
@@ -113,7 +113,8 @@ private static boolean isInvariantTypeArgument(MethodInvocationTree collectMetho
   }
 
   private void reportIssue(MethodInvocationTree collector, boolean mutable) {
-    String message = String.format(MESSAGE, mutable ? "toList" : "toUnmodifiableList");
+    String message = mutable? String.format(MESSAGE, "toList", " and ensure that the list is unmodified")
+      : String.format(MESSAGE, "toUnmodifiableList", "");
     reportIssue(collector, message);
   }