Package org.sonar.api.batch.sensor.issue

Interface Issue

All Superinterfaces:

IIssue

public interface Issue
extends IIssue

Represents an issue detected by a Sensor.

Since:

5.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Issue.Flow

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	codeVariants()
java.util.List<Issue.Flow>	flows()	List of flows for this issue.
java.lang.Double	gap()	Gap used to compute the effort for fixing the issue.
boolean	isQuickFixAvailable()	Is there a QuickFix available in SonarLint for this issue
Severity	overriddenSeverity()	Deprecated. since 10.1, use overridenImpacts() instead
java.util.Map<SoftwareQuality,Severity>	overridenImpacts()	Retrieve the overriden impacts for this issue.
IssueLocation	primaryLocation()	Primary locations for this issue.
java.util.List<QuickFix>	quickFixes()	The list of quick fixes contributed for this issue.
java.util.Optional<java.lang.String>	ruleDescriptionContextKey()	The optional rule description section context key, in case the analyzer detects a context for the issue.

Methods inherited from interface org.sonar.api.batch.sensor.issue.IIssue

ruleKey

Method Detail

gap

@CheckForNull
java.lang.Double gap()

Gap used to compute the effort for fixing the issue.

Since:

5.5

overriddenSeverity

@Deprecated(since="10.1")
@CheckForNull
Severity overriddenSeverity()

Deprecated.

since 10.1, use overridenImpacts() instead

Overridden severity.

overridenImpacts

java.util.Map<SoftwareQuality,Severity> overridenImpacts()

Retrieve the overriden impacts for this issue.

Since:

10.1

primaryLocation

IssueLocation primaryLocation()

Primary locations for this issue.

Specified by:

primaryLocation in interface IIssue

Since:

5.2

flows

java.util.List<Issue.Flow> flows()

List of flows for this issue. Can be empty.

Specified by:

flows in interface IIssue

Since:

5.2

isQuickFixAvailable

boolean isQuickFixAvailable()

Is there a QuickFix available in SonarLint for this issue

Since:

9.2

ruleDescriptionContextKey

java.util.Optional<java.lang.String> ruleDescriptionContextKey()

The optional rule description section context key, in case the analyzer detects a context for the issue. The key will match the one present in Context.getKey().

Since:

9.8

quickFixes

java.util.List<QuickFix> quickFixes()

The list of quick fixes contributed for this issue. Could be empty but never null.

Since:

9.13

codeVariants

@CheckForNull
java.util.List<java.lang.String> codeVariants()

Since:

9.17