SONARJAVA-5513 Update rule metadata (#5145)

Co-authored-by: romainbrenguier <[email protected]>

Author: github-actions[bot]

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S1186.html

@@ -10,6 +10,7 @@ <h2>Why is this an issue?</h2>
 <h3>Exceptions</h3>
 <p>This does not raise an issue in the following cases:</p>
 <ul>
+  <li> Methods with a comment to explain why they are empty </li>
   <li> Non-public default (no-argument) constructors </li>
   <li> Public default (no-argument) constructors when there are other constructors in the class </li>
   <li> Empty methods in abstract classes </li>
@@ -22,6 +23,7 @@ <h3>Exceptions</h3>
 }
 </pre>
 <h2>How to fix it</h2>
+<p>To fix this issue, either make the method do something, throw an exception, or add a comment to explain why it is empty.</p>
 <h3>Code examples</h3>
 <h4>Noncompliant code example</h4>
 <pre data-diff-id="1" data-diff-type="noncompliant">

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S1481.html

@@ -19,20 +19,100 @@ <h3>What is the potential impact?</h3>
 <p>In summary, unused local variables can make your code less readable, more confusing, and harder to maintain, and they can potentially lead to bugs
 or inefficient memory use. Therefore, it is best to remove them.</p>
 <h2>How to fix it</h2>
-<p>The fix for this issue is straightforward. Once you ensure the unused variable is not part of an incomplete implementation leading to bugs, you
-just need to remove it.</p>
+<p>The fix for this issue is straightforward. Once you ensure the unused variable is not part of an incomplete implementation, you just need to remove
+it.</p>
+<p>Java 22 introduces the unnamed variable pattern <code>_</code>. When a variable declared within a pattern match, an enhanced for loop, or a try
+with resource is unused, you should replace its name with the unnamed variable pattern to clearly indicate the intent not to use the variable.</p>
 <h3>Code examples</h3>
 <h4>Noncompliant code example</h4>
 <pre data-diff-id="1" data-diff-type="noncompliant">
 public int numberOfMinutes(int hours) {
-  int seconds = 0;   // Noncompliant - seconds is unused
+  int seconds = 0;   // Noncompliant: "seconds" is unused
   return hours * 60;
 }
 </pre>
+<pre data-diff-id="2" data-diff-type="noncompliant">
+public String name(Person p) {
+  return switch (p) {
+    case User(String name, int age) -&gt; name; // Noncompliant: "age" is unused replace it with the unnamed variable pattern (starting from Java 22)
+    default -&gt; throw new IllegalArgumentException();
+  };
+}
+</pre>
+<pre data-diff-id="3" data-diff-type="noncompliant">
+public String type(Person p) {
+  return switch (p) {
+    case User user -&gt; "user"; // Noncompliant:  "user" is unused replace it with the unnamed variable pattern (starting from Java 22)
+    default -&gt; throw new IllegalArgumentException();
+  };
+}
+</pre>
+<pre data-diff-id="4" data-diff-type="noncompliant">
+public int age(Person p) {
+  if (p instanceof User(String name, int age)) { // Noncompliant:  "name" is unused replace it with the unnamed variable pattern (starting from Java 22)
+    return age;
+  }
+}
+</pre>
+<pre data-diff-id="5" data-diff-type="noncompliant">
+public static int count(int[] elements) {
+  int count = 0;
+  for (var el : elements) { // Noncompliant:  "el" is unused replace it with the unnamed variable pattern (starting from Java 22)
+    count++;
+  }
+  return count;
+}
+</pre>
+<pre data-diff-id="6" data-diff-type="noncompliant">
+public void foo() {
+  try (var file = Files.createTempFile(directory, "temp", ".txt")) { // Noncompliant:  "file" is unused replace it with the unnamed variable pattern (starting from Java 22)
+    System.out.println("file created");
+  }
+}
+</pre>
 <h4>Compliant solution</h4>
 <pre data-diff-id="1" data-diff-type="compliant">
 public int numberOfMinutes(int hours) {
   return hours * 60;
 }
 </pre>
+<pre data-diff-id="2" data-diff-type="compliant">
+public String name(Person p) {
+  return switch (p) {
+    case User(String name, _) -&gt; name; // Compliant
+    default -&gt; throw new IllegalArgumentException();
+  };
+}
+</pre>
+<pre data-diff-id="3" data-diff-type="compliant">
+public String type(Person p) {
+  return switch (p) {
+    case User _ -&gt; "user"; // Compliant
+    default -&gt; throw new IllegalArgumentException();
+  };
+}
+</pre>
+<pre data-diff-id="4" data-diff-type="compliant">
+public int age(Person p) {
+  if (p instanceof User(String _, int age)) { // Compliant
+    return age;
+  }
+}
+</pre>
+<pre data-diff-id="5" data-diff-type="compliant">
+public static int count(int[] elements) {
+  int count = 0;
+  for (var _ : elements) { // Compliant
+    count++;
+  }
+  return count;
+}
+</pre>
+<pre data-diff-id="6" data-diff-type="compliant">
+public void foo() {
+  try (var _ = Files.createTempFile(directory, "temp", ".txt")) { // Compliant
+    System.out.println("file created");
+  }
+}
+</pre>
 

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S1481.json

@@ -13,6 +13,7 @@
     "constantCost": "5min"
   },
   "tags": [
+    "java22",
     "unused"
   ],
   "defaultSeverity": "Minor",

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S2384.html

@@ -4,6 +4,9 @@ <h2>Why is this an issue?</h2>
 <p>Instead use an unmodifiable <code>Collection</code> (via <code>Collections.unmodifiableCollection</code>,
 <code>Collections.unmodifiableList</code>, …​) or make a copy of the mutable object, and store or return the copy instead.</p>
 <p>This rule checks that private arrays, collections and Dates are not stored or returned directly.</p>
+<h3>Exceptions</h3>
+<p>The rule violation is not reported for mutable values stored in private methods if no non-private methods directly passes a mutable parameter to
+them.</p>
 <h3>Noncompliant code example</h3>
 <pre>
 class A {
@@ -44,6 +47,10 @@ <h3>Compliant solution</h3>
     return strings.clone();
   }
 
+  private void setStringsInternal(String [] strings) {
+    this.strings = strings;
+  }
+
   public void setStrings(String [] strings) {
     this.strings = strings.clone();
   }

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S3753.html

@@ -7,7 +7,7 @@ <h2>Why is this an issue?</h2>
 <h3>Noncompliant code example</h3>
 <pre>
 @Controller
-@SessionAttributes("hello")  // Noncompliant; this doesn't get cleaned up
+@SessionAttributes("hello")  // Noncompliant: this doesn't get cleaned up
 public class HelloWorld {
 
   @RequestMapping("/greet", method = GET)

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S4682.html

@@ -1,6 +1,6 @@
 <h2>Why is this an issue?</h2>
-<p>By definition, primitive types are not Objects and so they can’t be <code>null</code>. Adding <code>@CheckForNull</code> or <code>@Nullable</code>
-on primitive types adds confusion and is useless.</p>
+<p>By definition, primitive types are not Objects and so they cannot be <code>null</code>. Adding <code>@CheckForNull</code> or <code>@Nullable</code>
+on primitive types is redundant and may lead to misunderstandings.</p>
 <p>This rule raises an issue when <code>@CheckForNull</code> or <code>@Nullable</code> is set on a method returning a primitive type: byte, short,
 int, long, float, double, boolean, char.</p>
 <h3>Noncompliant code example</h3>

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S6818.html

@@ -1,7 +1,7 @@
 <h2>Why is this an issue?</h2>
 <p><code>@Autowired</code> is an annotation in the Spring Framework for automatic dependency injection. It tells Spring to automatically provide the
 required dependencies (such as other beans or components) to a class’s fields, methods, or constructors, allowing for easier and more flexible
-management of dependencies in a Spring application. In other words, it’s a way to wire up and inject dependencies into Spring components
+management of dependencies in a Spring application. In other words, it is a way to wire up and inject dependencies into Spring components
 automatically, reducing the need for manual configuration and enhancing modularity and maintainability.</p>
 <p>In any bean class, only one constructor is permitted to declare <code>@Autowired</code> with the <code>required</code> attribute set to true. This
 signifies the constructor to be automatically wired when used as a Spring bean. Consequently, when the required attribute remains at its default value

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S6829.html

@@ -6,21 +6,21 @@ <h2>Why is this an issue?</h2>
 maintain.</p>
 <h3>What is the potential impact?</h3>
 <ul>
-  <li> <strong>Incorrect Instantiation</strong>: the wrong constructor is selected for instantiation, leading to a bean not being correctly
+  <li> <strong>incorrect instantiation</strong>: the wrong constructor is selected for instantiation, leading to a bean not being correctly
   initialized. </li>
-  <li> <strong>Unsatisfied Dependency Exception</strong>: the constructor selected by Spring requires beans that are not available in the Spring
+  <li> <strong>unsatisfied dependency exception</strong>: the constructor selected by Spring requires beans that are not available in the Spring
   context. </li>
-  <li> <strong>Non-Deterministic Behavior</strong>: the constructor selected by Spring can vary, based on the number of dependencies that can be
+  <li> <strong>non-deterministic behavior</strong>: the constructor selected by Spring can vary, based on the number of dependencies that can be
   satisfied at runtime, leading to unpredictable application behavior. </li>
-  <li> <strong>Maintainability Issues</strong>: adding more constructors in the future could lead to further confusion and potential bugs. </li>
+  <li> <strong>maintainability issues</strong>: adding more constructors in the future could lead to further confusion and potential bugs. </li>
 </ul>
 <h2>How to fix it</h2>
 <p>Use the <code>@Autowired</code> annotation to specify which constructor to use for auto-wiring.</p>
 <h3>Code examples</h3>
 <h4>Noncompliant code example</h4>
 <pre data-diff-id="1" data-diff-type="noncompliant">
 @Component
-public class ExampleClass { // Noncompliant, multiple constructors present and no @Autowired annotation to specify which one to use
+public class ExampleClass { // Noncompliant: multiple constructors present and no @Autowired annotation to specify which one to use
 
     private final DependencyClass1 dependency1;
 

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S6838.html

@@ -37,7 +37,7 @@ <h4>Noncompliant code example</h4>
   @Bean
   @Scope("prototype")
   public PrototypeBean prototypeBean() {
-    return new PrototypeBean(singletonBean()); // Noncompliant, the singletonBean is created every time a prototypeBean is created
+    return new PrototypeBean(singletonBean()); // Noncompliant: a "singletonBean" is created every time a prototypeBean is created
   }
 
   class SingletonBean {

sonar-java-plugin/src/main/resources/org/sonar/l10n/java/rules/java/S6857.html

@@ -1,31 +1,41 @@
-<p>This rule reports syntax errors in Spring Expression Language (SpEL) expressions.</p>
+<p>This rule reports syntax errors in Spring Expression Language (<code>SpEL</code>) expressions and property placeholders. It verifies that every
+<code>SpEL</code> expression and property placeholder is properly closed and that the content of each expression or placeholder is syntactically
+correct.</p>
 <h2>Why is this an issue?</h2>
-<p>SpEL is used in Spring annotations and is parsed by the Spring framework, not by the Java compiler. This means that invalid SpEL expressions are
-not detected during Java compile time. They will cause exceptions during runtime instead, or even fail silently with the expression string interpreted
-as a simple string literal by Spring.</p>
+<p>Only the Spring framework, not the Java compiler, parses <code>SpEL</code> expression inside Spring annotations. This means that the Java compiler
+does not detect invalid <code>SpEL</code> expressions during compile time. They will cause exceptions during runtime instead, or even fail silently
+when Spring interprets the expression as a simple string literal.</p>
 <h3>Exceptions</h3>
-<p>This rule does report syntactical errors in SpEL expressions but does not consider semantic errors, such as unknown identifiers or incompatible
-operand data types.</p>
+<p>This rule reports syntactical errors in <code>SpEL</code> expressions but does not consider semantic errors, such as unknown identifiers or
+incompatible operand data types.</p>
 <h2>How to fix it</h2>
 <p>Correct the syntax error in the SpEL expression.</p>
 <h3>Code examples</h3>
 <h4>Noncompliant code example</h4>
 <pre data-diff-id="1" data-diff-type="noncompliant">
-@Value("#{systemProperties['user.region'}") // Noncompliant, unclosed "["
+@Value("#{systemProperties['user.region'}") // Noncompliant: unclosed "["
 private String region;
 </pre>
 <pre data-diff-id="2" data-diff-type="noncompliant">
-@Value("#{'${listOfValues}' split(',')}") // Noncompliant, missing operator
+@Value("#{'${listOfValues}' split(',')}") // Noncompliant: missing operator
 private List&lt;String&gt; valuesList;
 </pre>
 <pre data-diff-id="3" data-diff-type="noncompliant">
-@Value("#{T(java.lang.Math).random() * 64h}") // Noncompliant, invalid number
+@Value("#{T(java.lang.Math).random() * 64h}") // Noncompliant: invalid number
 private Double randPercent;
 </pre>
 <pre data-diff-id="4" data-diff-type="noncompliant">
-@Query("SELECT u FROM User u WHERE u.status = :#{#status+}") // Noncompliant, missing operand for "+"
+@Query("SELECT u FROM User u WHERE u.status = :#{#status+}") // Noncompliant: missing operand for "+"
 List&lt;User&gt; findUsersByStatus(@Param("status") String status);
 </pre>
+<pre data-diff-id="5" data-diff-type="noncompliant">
+@Value("${myapp.!prop}") // Noncompliant: property key contains an exclamation mark "!"
+private String myProperty;
+</pre>
+<pre data-diff-id="6" data-diff-type="noncompliant">
+@Value("${my.property:#{1**1}}") // Noncompliant: invalid SpEL expression "1**1"
+private Integer myValue;
+</pre>
 <h4>Compliant solution</h4>
 <pre data-diff-id="1" data-diff-type="compliant">
 @Value("#{systemProperties['user.region']}") // Compliant
@@ -43,10 +53,18 @@ <h4>Compliant solution</h4>
 @Query("SELECT u FROM User u WHERE u.status = :#{#status+42}") // Compliant
 List&lt;User&gt; findUsersByStatus(@Param("status") String status);
 </pre>
+<pre data-diff-id="5" data-diff-type="compliant">
+@Value("${myapp.prop}") // Compliant
+private String myProperty;
+</pre>
+<pre data-diff-id="6" data-diff-type="compliant">
+@Value("${my.property:#{1*1}}") // Compliant
+private Integer myValue;
+</pre>
 <h2>Resources</h2>
 <h3>Documentation</h3>
 <ul>
-  <li> <a href="https://docs.spring.io/spring-framework/reference/core/expressions.html">Spring Framework - Spring Expression Language (SpEL)</a>
-  </li>
+  <li> Spring Framework Documentation - <a href="https://docs.spring.io/spring-framework/reference/core/expressions.html">Spring Expression Language
+  (SpEL)</a> </li>
 </ul>