org.sonar.api.issue

Interface Issuable

All Superinterfaces:

Perspective

public interface Issuable
extends Perspective

This perspective allows to add issues related to the selected component. It can be used from Sensors.
Example:

   import org.sonar.api.component.ResourcePerspectives;
   public class MySensor extends Sensor {
     private final ResourcePerspectives perspectives;

     public MySensor(ResourcePerspectives p) {
       this.perspectives = p;
     }

     public void analyse(Project project, SensorContext context) {
       Resource myResource; // to be set
       Issuable issuable = perspectives.as(Issuable.class, myResource);
       if (issuable != null) {
         // can be used
         Issue issue = issuable.newIssueBuilder()
           .setRuleKey(RuleKey.of("pmd", "AvoidArrayLoops")
           .setLine(10)
           .build();
         issuable.addIssue(issue);
       }
     }
   }
 

Since:

3.6

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Issuable.IssueBuilder

Method Summary

Modifier and Type	Method and Description
boolean	addIssue(Issue issue) Register an issue created with newIssueBuilder().
List<Issue>	issues() Deprecated. since 5.2 no more decorators on batch side
Issuable.IssueBuilder	newIssueBuilder() Builder is used to create the issue to be passed to addIssue(Issue)
List<Issue>	resolvedIssues() Deprecated. since 5.2 no more decorators on batch side

Method Detail

newIssueBuilder

Issuable.IssueBuilder newIssueBuilder()

Builder is used to create the issue to be passed to addIssue(Issue)

addIssue

boolean addIssue(Issue issue)

Register an issue created with newIssueBuilder().
This method is usually called from Sensors. Decorators calling this method must be annotated with @DependedUpon(DecoratorBarriers.ISSUES_ADDED).

Returns:

true if the new issue is registered, false if the related rule does not exist or is disabled in the Quality profile.

issues

@Deprecated
List<Issue> issues()

Deprecated. since 5.2 no more decorators on batch side

resolvedIssues

@Deprecated
List<Issue> resolvedIssues()

Deprecated. since 5.2 no more decorators on batch side