Skip to content

Commit 3900fea

Browse files
leo-geoffroy-sonarsourcedbmeneses
authored andcommitted
PLUGINAPI-64 Mark external issue impacts and cleanCodeAttribute as @beta
1 parent 1dc1674 commit 3900fea

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121

2222
import java.util.Map;
2323
import javax.annotation.CheckForNull;
24+
import org.sonar.api.Beta;
2425
import org.sonar.api.batch.rule.Severity;
2526
import org.sonar.api.batch.sensor.Sensor;
2627
import org.sonar.api.rules.CleanCodeAttribute;
@@ -66,14 +67,18 @@ public interface ExternalIssue extends IIssue {
6667

6768
/**
6869
* Impacts of the issue.
70+
* This method is experimental and might change in the future
6971
* @since 10.1
7072
*/
73+
@Beta
7174
Map<SoftwareQuality, org.sonar.api.issue.impact.Severity> impacts();
7275

7376
/**
7477
* Clean Code Attribute of the issue.
78+
* This method is experimental and might change in the future
7579
* @since 10.1
7680
*/
81+
@Beta
7782
@CheckForNull
7883
CleanCodeAttribute cleanCodeAttribute();
7984

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
package org.sonar.api.batch.sensor.issue;
2121

2222
import javax.annotation.Nullable;
23+
import org.sonar.api.Beta;
2324
import org.sonar.api.batch.rule.Severity;
2425
import org.sonar.api.batch.sensor.Sensor;
2526
import org.sonar.api.issue.impact.SoftwareQuality;
@@ -63,8 +64,10 @@ public interface NewExternalIssue {
6364
/**
6465
* Attribute of the issue according to Clean Code Taxonomy.
6566
* Providing it is optional for now but will become mandatory in the future.
67+
* This method is experimental and might change in the future.
6668
* @since 10.1
6769
*/
70+
@Beta
6871
NewExternalIssue cleanCodeAttribute(CleanCodeAttribute attribute);
6972

7073
/**
@@ -82,8 +85,10 @@ public interface NewExternalIssue {
8285
/**
8386
* Add a new impact or override the severity of an impact already defined by the rule.
8487
* It is only possible to define a default impact for a given {@link SoftwareQuality}
88+
* This method is experimental and might change in the future.
8589
* @since 10.1
8690
*/
91+
@Beta
8792
NewExternalIssue addImpact(SoftwareQuality softwareQuality, org.sonar.api.issue.impact.Severity severity);
8893

8994
/**

0 commit comments

Comments
 (0)