org.sonar.api.batch.sensor.issue

Interface NewIssue

All Known Implementing Classes:

DefaultIssue

public interface NewIssue

Represents an issue detected by a Sensor.

Since:

5.1

Method Summary

Modifier and Type	Method and Description
NewIssue	addFlow(Iterable<NewIssueLocation> flowLocations) Register a flow for this issue.
NewIssue	addLocation(NewIssueLocation secondaryLocation) Add a secondary location for this issue.
NewIssue	at(NewIssueLocation primaryLocation) Primary location for this issue.
NewIssue	effortToFix(Double effortToFix) Deprecated. since 5.5 use gap(Double)
NewIssue	forRule(RuleKey ruleKey) The RuleKey of the issue.
NewIssue	gap(Double gap) Gap used for the computation of the effort.
NewIssueLocation	newLocation() Create a new location for this issue.
NewIssue	overrideSeverity(Severity severity) Override severity of the issue.
void	save() Save the issue.

Method Detail

forRule

NewIssue forRule(RuleKey ruleKey)

The RuleKey of the issue.

effortToFix

@Deprecated
NewIssue effortToFix(@Nullable
                                 Double effortToFix)

Deprecated. since 5.5 use gap(Double)

Effort to fix the issue.

gap

NewIssue gap(@Nullable
             Double gap)

Gap used for the computation of the effort.

Since:

5.5

overrideSeverity

NewIssue overrideSeverity(@Nullable
                          Severity severity)

Override severity of the issue. Setting a null value or not calling this method means to use severity configured in quality profile.

at

NewIssue at(NewIssueLocation primaryLocation)

Primary location for this issue.

Since:

5.2

addLocation

NewIssue addLocation(NewIssueLocation secondaryLocation)

Add a secondary location for this issue. Several secondary locations can be registered.

Since:

5.2

addFlow

NewIssue addFlow(Iterable<NewIssueLocation> flowLocations)

Register a flow for this issue. A flow is an ordered list of issue locations that help to understand the issue. It could be a path leading to the primary location. Several flows can be registered.

Since:

5.2

newLocation

NewIssueLocation newLocation()

Create a new location for this issue. First registered location is considered as primary location.

Since:

5.2

save

void save()

Save the issue. If rule key is unknown or rule not enabled in the current quality profile then a warning is logged but no exception is thrown.