org.sonar.api.batch.sensor.issue.internal

Class DefaultIssue

java.lang.Object

org.sonar.api.batch.sensor.internal.DefaultStorable

org.sonar.api.batch.sensor.issue.internal.DefaultIssue

All Implemented Interfaces:

Issue, NewIssue

public class DefaultIssue
extends DefaultStorable
implements Issue, NewIssue

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonar.api.batch.sensor.issue.Issue

Issue.Flow

Field Summary

Fields inherited from class org.sonar.api.batch.sensor.internal.DefaultStorable

storage

Constructor Summary

Constructors

Constructor and Description
DefaultIssue()
DefaultIssue(SensorStorage storage)

Method Summary

Modifier and Type	Method and Description
DefaultIssue	addFlow(Iterable<NewIssueLocation> locations) Register a flow for this issue.
NewIssue	addLocation(NewIssueLocation secondaryLocation) Add a secondary location for this issue.
DefaultIssue	at(NewIssueLocation primaryLocation) Primary location for this issue.
void	doSave()
Double	effortToFix() Effort to fix the issue.
DefaultIssue	effortToFix(Double effortToFix) Effort to fix the issue.
List<Issue.Flow>	flows() List of flows for this issue.
DefaultIssue	forRule(RuleKey ruleKey) The RuleKey of the issue.
Double	gap() Gap used to compute the effort for fixing the issue.
DefaultIssue	gap(Double gap) Gap used for the computation of the effort.
NewIssueLocation	newLocation() Create a new location for this issue.
Severity	overriddenSeverity() Overridden severity.
DefaultIssue	overrideSeverity(Severity severity) Override severity of the issue.
IssueLocation	primaryLocation() Primary locations for this issue.
RuleKey	ruleKey() The RuleKey of this issue.

Methods inherited from class org.sonar.api.batch.sensor.internal.DefaultStorable

save, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

save

Constructor Detail

DefaultIssue

public DefaultIssue()

DefaultIssue

public DefaultIssue(SensorStorage storage)

Method Detail

forRule

public DefaultIssue forRule(RuleKey ruleKey)

Description copied from interface: NewIssue

The RuleKey of the issue.

Specified by:

forRule in interface NewIssue

effortToFix

public DefaultIssue effortToFix(@Nullable
                                Double effortToFix)

Description copied from interface: NewIssue

Effort to fix the issue.

Specified by:

effortToFix in interface NewIssue

gap

public DefaultIssue gap(@Nullable
                        Double gap)

Description copied from interface: NewIssue

Gap used for the computation of the effort.

Specified by:

gap in interface NewIssue

overrideSeverity

public DefaultIssue overrideSeverity(@Nullable
                                     Severity severity)

Description copied from interface: NewIssue

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

Specified by:

overrideSeverity in interface NewIssue

newLocation

public NewIssueLocation newLocation()

Description copied from interface: NewIssue

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

Specified by:

newLocation in interface NewIssue

at

public DefaultIssue at(NewIssueLocation primaryLocation)

Description copied from interface: NewIssue

Primary location for this issue.

Specified by:

at in interface NewIssue

addLocation

public NewIssue addLocation(NewIssueLocation secondaryLocation)

Description copied from interface: NewIssue

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

Specified by:

addLocation in interface NewIssue

addFlow

public DefaultIssue addFlow(Iterable<NewIssueLocation> locations)

Description copied from interface: NewIssue

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

Specified by:

addFlow in interface NewIssue

ruleKey

public RuleKey ruleKey()

Description copied from interface: Issue

The RuleKey of this issue.

Specified by:

ruleKey in interface Issue

overriddenSeverity

public Severity overriddenSeverity()

Description copied from interface: Issue

Overridden severity.

Specified by:

overriddenSeverity in interface Issue

gap

public Double gap()

Description copied from interface: Issue

Gap used to compute the effort for fixing the issue.

Specified by:

gap in interface Issue

effortToFix

public Double effortToFix()

Description copied from interface: Issue

Effort to fix the issue. Used by technical debt model.

Specified by:

effortToFix in interface Issue

primaryLocation

public IssueLocation primaryLocation()

Description copied from interface: Issue

Primary locations for this issue.

Specified by:

primaryLocation in interface Issue

flows

public List<Issue.Flow> flows()

Description copied from interface: Issue

List of flows for this issue. Can be empty.

Specified by:

flows in interface Issue

doSave

public void doSave()

Specified by:

doSave in class DefaultStorable