SONAR-5931 Cleanup new issue API

4 files changed, 15 insertions, 5 deletions

diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewIssue.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewIssue.java
index 8819fc23b25..734627d568d 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewIssue.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/NewIssue.java
@@ -37,7 +37,7 @@ public interface NewIssue {
   /**
    * The {@link RuleKey} of the issue.
    */
-  NewIssue ruleKey(RuleKey ruleKey);
+  NewIssue forRule(RuleKey ruleKey);
 
   /**
    * The {@link InputFile} the issue belongs to. For global issues call {@link #onProject()}.
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/internal/DefaultIssue.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/internal/DefaultIssue.java
index c029722eb9d..585ebcf647a 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/internal/DefaultIssue.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/sensor/issue/internal/DefaultIssue.java
@@ -61,7 +61,7 @@ public class DefaultIssue extends DefaultStorable implements Issue, NewIssue {
   }
 
   @Override
-  public DefaultIssue ruleKey(RuleKey ruleKey) {
+  public DefaultIssue forRule(RuleKey ruleKey) {
     this.ruleKey = ruleKey;
     return this;
   }
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issuable.java b/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issuable.java
index 73160cfc23d..3e7ef41be85 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issuable.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issuable.java
@@ -20,10 +20,12 @@
 
 package org.sonar.api.issue;
 
+import org.sonar.api.batch.sensor.SensorContext;
 import org.sonar.api.component.Perspective;
 import org.sonar.api.rule.RuleKey;
 
 import javax.annotation.Nullable;
+
 import java.util.List;
 
 /**
@@ -59,6 +61,10 @@ import java.util.List;
  */
 public interface Issuable extends Perspective {
 
+  /**
+   * @deprecated since 5.1 use {@link SensorContext#newIssue()}
+   */
+  @Deprecated
   interface IssueBuilder {
     /**
      * The rule key is mandatory. Example: {@code RuleKey.of("pmd", "AvoidArrayLoops")}
@@ -97,7 +103,9 @@ public interface Issuable extends Perspective {
 
   /**
    * Builder is used to create the issue to be passed to {@link #addIssue(Issue)}
+   * @deprecated since 5.1 use {@link SensorContext#newIssue()}
    */
+  @Deprecated
   IssueBuilder newIssueBuilder();
 
   /**
@@ -107,7 +115,9 @@ public interface Issuable extends Perspective {
    * method must be annotated with {@code @DependedUpon(DecoratorBarriers.ISSUES_ADDED)}.
    *
    * @return true if the new issue is registered, false if the related rule does not exist or is disabled in the Quality profile.
+   * @deprecated since 5.1 use {@link SensorContext#newIssue()}
    */
+  @Deprecated
   boolean addIssue(Issue issue);
 
   /**
diff --git a/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/issue/internal/DefaultIssueTest.java b/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/issue/internal/DefaultIssueTest.java
index 8973939afe3..86be3bd947f 100644
--- a/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/issue/internal/DefaultIssueTest.java
+++ b/sonar-plugin-api/src/test/java/org/sonar/api/batch/sensor/issue/internal/DefaultIssueTest.java
@@ -40,7 +40,7 @@ public class DefaultIssueTest {
     SensorStorage storage = mock(SensorStorage.class);
     DefaultIssue issue = new DefaultIssue(storage)
       .onFile(new DefaultInputFile("foo", "src/Foo.php"))
-      .ruleKey(RuleKey.of("repo", "rule"))
+      .forRule(RuleKey.of("repo", "rule"))
       .atLine(1)
       .effortToFix(10.0)
       .message("Wrong way!");
@@ -61,7 +61,7 @@ public class DefaultIssueTest {
     SensorStorage storage = mock(SensorStorage.class);
     DefaultIssue issue = new DefaultIssue(storage)
       .onProject()
-      .ruleKey(RuleKey.of("repo", "rule"))
+      .forRule(RuleKey.of("repo", "rule"))
       .effortToFix(10.0)
       .message("Wrong way!");
 
@@ -83,7 +83,7 @@ public class DefaultIssueTest {
     new DefaultIssue()
       .onProject()
       .onFile(new DefaultInputFile("foo", "src/Foo.php"))
-      .ruleKey(RuleKey.of("repo", "rule"))
+      .forRule(RuleKey.of("repo", "rule"))
       .atLine(1)
       .effortToFix(10.0)
       .message("Wrong way!");