PLUGINAPI-155 Add issue internal tags (#246)

Co-authored-by: antoine.vinot <antoine.vinot@sonarsource.com>

Author: aleksandra-bozhinoska-sonarsource

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 13.1
+* Introduce support for internal tags on issues:
+  * Introduce `org.sonar.api.batch.sensor.issue.Issue.internalTags()`
+  * Introduce `org.sonar.api.batch.sensor.issue.NewIssue.addInternalTag(String tag)`
+  * Introduce `org.sonar.api.batch.sensor.issue.NewIssue.addInternalTags(Collection<String> tags)`
+  * Introduce `org.sonar.api.batch.sensor.issue.NewIssue.setInternalTags(@Nullable Collection<String> tags)`
+
 ## 13.0
 * Remove deprecated complexity metrics:
   * `org.sonar.api.measures.CoreMetrics.FILE_COMPLEXITY`.

plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/Issue.java

@@ -23,6 +23,7 @@
 import java.util.Map;
 import java.util.Optional;
 import javax.annotation.CheckForNull;
+import org.sonar.api.Beta;
 import org.sonar.api.batch.rule.Severity;
 import org.sonar.api.batch.sensor.Sensor;
 import org.sonar.api.batch.sensor.issue.NewIssue.FlowType;
@@ -112,4 +113,13 @@ interface Flow {
    */
   @CheckForNull
   List<String> codeVariants();
+
+  /**
+   * Technical tags for the issue - for internal use only.
+   * This API is experimental and can be changed or dropped at any time.
+   *
+   * @since 13.1
+   */
+  @Beta
+  List<String> internalTags();
 }

plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewIssue.java

@@ -19,6 +19,7 @@
  */
 package org.sonar.api.batch.sensor.issue;
 
+import java.util.Collection;
 import javax.annotation.Nullable;
 import org.sonar.api.batch.rule.Severity;
 import org.sonar.api.batch.sensor.Sensor;
@@ -149,4 +150,29 @@ enum FlowType {
    */
   NewIssue setCodeVariants(@Nullable Iterable<String> codeVariants);
 
+  /**
+   * Register an internal tag for this issue.
+   *
+   * @param tag a String tag
+   * @since 13.1
+   */
+  NewIssue addInternalTag(String tag);
+
+  /**
+   * Register a collection of internal tags for this issue.
+   *
+   * @param tag a Collection of String tags
+   * @since 13.1
+   */
+  NewIssue addInternalTags(Collection<String> tags);
+
+  /**
+   * Set the internal tags for this issue.
+   * This will override any previously set internal tags.
+   *
+   * @param tags a Collection of String tags
+   * @since 13.1
+   */
+  NewIssue setInternalTags(@Nullable Collection<String> tags);
+
 }