API review

Author: ericg138

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 13.5
+* Introduce support for issue resolution from sensors:
+  * Introduce `org.sonar.api.batch.sensor.issue.NewIssueResolution`
+  * Introduce `org.sonar.api.batch.sensor.issue.IssueResolution`
+  * Introduce `org.sonar.api.batch.sensor.SensorContext.newIssueResolution()`
+  * Introduce `org.sonar.api.batch.sensor.internal.SensorStorage.store(IssueResolution)`
+
 ## 13.4
 * Add `org.sonar.api.a3s.A3SContextCollector` (internal SonarSource usage)
 

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

@@ -21,7 +21,6 @@
 
 import java.io.InputStream;
 import java.io.Serializable;
-import java.util.Collection;
 import org.sonar.api.Beta;
 import org.sonar.api.SonarRuntime;
 import org.sonar.api.batch.fs.FileSystem;
@@ -37,6 +36,7 @@
 import org.sonar.api.batch.sensor.highlighting.NewHighlighting;
 import org.sonar.api.batch.sensor.issue.ExternalIssue;
 import org.sonar.api.batch.sensor.issue.Issue;
+import org.sonar.api.batch.sensor.issue.IssueResolution;
 import org.sonar.api.batch.sensor.issue.NewExternalIssue;
 import org.sonar.api.batch.sensor.issue.NewIssue;
 import org.sonar.api.batch.sensor.measure.Measure;
@@ -46,7 +46,7 @@
 import org.sonar.api.batch.sensor.symbol.NewSymbolTable;
 import org.sonar.api.config.Configuration;
 import org.sonar.api.config.Settings;
-import org.sonar.api.issue.SonarResolveData;
+import org.sonar.api.batch.sensor.issue.NewIssueResolution;
 import org.sonar.api.scanner.fs.InputProject;
 import org.sonar.api.scanner.sensor.ProjectSensor;
 import org.sonar.api.utils.Version;
@@ -309,10 +309,9 @@ public interface SensorContext {
   boolean isFeatureAvailable(String featureName);
 
   /**
-   * Register sonar-resolve annotations for a file.
-   * @param inputFile the file containing the annotations
-   * @param data the annotation data parsed from the file
+   * Builder to create a new {@link IssueResolution}.
+   * Don't forget to call {@link NewIssueResolution#save()} once all parameters are provided.
    * @since 13.5
    */
-  void addSonarResolveData(InputFile inputFile, Collection<SonarResolveData> data);
+  NewIssueResolution newIssueResolution();
 }

plugin-api/src/main/java/org/sonar/api/batch/sensor/internal/SensorStorage.java

@@ -28,6 +28,7 @@
 import org.sonar.api.batch.sensor.issue.Issue;
 import org.sonar.api.batch.sensor.measure.Measure;
 import org.sonar.api.batch.sensor.rule.AdHocRule;
+import org.sonar.api.batch.sensor.issue.IssueResolution;
 import org.sonar.api.batch.sensor.symbol.NewSymbolTable;
 import org.sonar.api.scanner.ScannerSide;
 
@@ -82,4 +83,9 @@ public interface SensorStorage {
    * @since 7.2
    */
   void store(NewSignificantCode significantCode);
+
+  /**
+   * @since 13.5
+   */
+  void store(IssueResolution issueResolution);
 }

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

@@ -0,0 +1,48 @@
+/*
+ * Sonar Plugin API
+ * Copyright (C) 2009-2025 SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.api.batch.sensor.issue;
+
+import java.util.Set;
+import javax.annotation.CheckForNull;
+import org.sonar.api.batch.fs.InputFile;
+import org.sonar.api.batch.fs.TextRange;
+import org.sonar.api.rule.RuleKey;
+
+/**
+ * Represents a request to resolve one or more issues at a given location.
+ *
+ * @since 13.5
+ */
+public interface IssueResolution {
+
+  enum Status {ACCEPT, FALSE_POSITIVE}
+
+  @CheckForNull
+  InputFile inputFile();
+
+  @CheckForNull
+  TextRange textRange();
+
+  Status status();
+
+  Set<RuleKey> ruleKeys();
+
+  String comment();
+}

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

@@ -0,0 +1,64 @@
+/*
+ * Sonar Plugin API
+ * Copyright (C) 2009-2025 SonarSource Sàrl
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+package org.sonar.api.batch.sensor.issue;
+
+import java.util.Collection;
+import org.sonar.api.batch.fs.InputFile;
+import org.sonar.api.batch.fs.TextRange;
+import org.sonar.api.rule.RuleKey;
+
+/**
+ * Builder for an {@link IssueResolution}. Use {@code context.newIssueResolution()} to create.
+ * {@link #save()} should be called once all parameters are provided.
+ *
+ * @since 13.5
+ */
+public interface NewIssueResolution {
+
+  /**
+   * Set the target file.
+   */
+  NewIssueResolution on(InputFile inputFile);
+
+  /**
+   * Set the target text range within the file.
+   */
+  NewIssueResolution at(TextRange textRange);
+
+  /**
+   * Set the resolution status. Defaults to {@link IssueResolution.Status#ACCEPT}.
+   */
+  NewIssueResolution status(IssueResolution.Status status);
+
+  /**
+   * Set the target rule keys. At least one rule key is required.
+   */
+  NewIssueResolution forRules(Collection<RuleKey> ruleKeys);
+
+  /**
+   * Set a justification comment. Required.
+   */
+  NewIssueResolution comment(String comment);
+
+  /**
+   * Save the issue resolution.
+   */
+  void save();
+}