Skip to content

Commit

Permalink
Add deprecation reason to rules
Browse files Browse the repository at this point in the history
  • Loading branch information
johann-beleites-sonarsource committed Aug 29, 2024
1 parent c85ef60 commit bdf09a1
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 1 deletion.
4 changes: 4 additions & 0 deletions rules/S2259/java/rule.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@

_We are deprecating our legacy symbolic execution engine in favor of our more advanced commercial engine.
The legacy engine will remain Open Source for the community as a separate plugin and will receive no further updates by SonarSource._

== Why is this an issue?

A reference to `null` should never be dereferenced/accessed.
Expand Down
4 changes: 4 additions & 0 deletions rules/S2583/java/rule.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@

_We are deprecating our legacy symbolic execution engine in favor of our more advanced commercial engine.
The legacy engine will remain Open Source for the community as a separate plugin and will receive no further updates by SonarSource._

== Why is this an issue?

include::../description.adoc[]
Expand Down
4 changes: 4 additions & 0 deletions rules/S2589/java/rule.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@

_We are deprecating our legacy symbolic execution engine in favor of our more advanced commercial engine.
The legacy engine will remain Open Source for the community as a separate plugin and will receive no further updates by SonarSource._

include::../description-common.adoc[]

=== Code examples
Expand Down
4 changes: 4 additions & 0 deletions rules/S3518/java/rule.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@

_We are deprecating our legacy symbolic execution engine in favor of our more advanced commercial engine.
The legacy engine will remain Open Source for the community as a separate plugin and will receive no further updates by SonarSource._


If the denominator to an integer division or remainder operation is zero, a
`ArithmeticException` is thrown.

Expand Down
6 changes: 5 additions & 1 deletion rules/S3655/java/rule.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@

_We are deprecating our legacy symbolic execution engine in favor of our more advanced commercial engine.
The legacy engine will remain Open Source for the community as a separate plugin and will receive no further updates by SonarSource._

== Why is this an issue?

``++Optional++`` value can hold either a value or not. The value held in the ``++Optional++`` can be accessed using the ``++get()++`` method, but it will throw a
``++Optional++`` value can hold either a value or not. The value held in the ``++Optional++`` can be accessed using the ``++get()++`` method, but it will throw a

``++NoSuchElementException++`` if there is no value present. To avoid the exception, calling the ``++isPresent()++`` or ``++! isEmpty()++`` method should always be done before any call to ``++get()++``.

Expand Down
4 changes: 4 additions & 0 deletions rules/S3959/java/rule.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@

_We are deprecating our legacy symbolic execution engine in favor of our more advanced commercial engine.
The legacy engine will remain Open Source for the community as a separate plugin and will receive no further updates by SonarSource._

== Why is this an issue?

Stream operations are divided into intermediate and terminal operations, and are combined to form stream pipelines. After the terminal operation is performed, the stream pipeline is considered consumed, and cannot be used again. Such a reuse will yield unexpected results.
Expand Down

0 comments on commit bdf09a1

Please sign in to comment.