PLUGINAPI-47 Add code variants to issues

SonarSource · May 8, 2023 · 2d91621 · 2d91621
1 parent 32af766
commit 2d91621
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/Issue.java b/plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/Issue.java
@@ -98,4 +98,10 @@ interface Flow {
    * @since 9.13
    */
   List<QuickFix> quickFixes();
+
+  /**
+   * @since 9.17
+   */
+  @CheckForNull
+  List<String> codeVariants();
 }
diff --git a/plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewIssue.java b/plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewIssue.java
@@ -133,4 +133,12 @@ enum FlowType {
    */
   NewIssue setRuleDescriptionContextKey(@Nullable String ruleDescriptionContextKey);
 
+  /**
+   * Registers a list of code variants for this issue.
+   * In C and C++, it is commonplace to have multiple code variants. Two source codes are defined here as variants of each other if there
+   * is any difference in their preprocessed source code.
+   * @since 9.17
+   */
+  NewIssue setCodeVariants(@Nullable Iterable<String> codeVariants);
+
 }
diff --git a/plugin-api/src/main/java/org/sonar/api/issue/Issue.java b/plugin-api/src/main/java/org/sonar/api/issue/Issue.java
@@ -255,4 +255,10 @@ public interface Issue extends Serializable {
    * @since 5.1
    */
   Collection<String> tags();
+
+  /**
+   * @since 9.17
+   */
+  @CheckForNull
+  Collection<String> codeVariants();
 }