org.sonar.api.issue

Interface Issuable.IssueBuilder

Enclosing interface:

Issuable

public static interface Issuable.IssueBuilder

Method Summary

Methods

Modifier and Type	Method and Description
Issuable.IssueBuilder	addFlow(Iterable<NewIssueLocation> flowLocations)
Issuable.IssueBuilder	addLocation(NewIssueLocation secondaryLocation)
Issuable.IssueBuilder	at(NewIssueLocation primaryLocation)
Issuable.IssueBuilder	attribute(String key, String value) No more supported from batch side since 5.2
Issue	build()
Issuable.IssueBuilder	effortToFix(Double d)
Issuable.IssueBuilder	line(Integer line) Deprecated. since 5.2 use at(NewIssueLocation)
Issuable.IssueBuilder	message(String message) Deprecated. since 5.2 use at(NewIssueLocation)
NewIssueLocation	newLocation()
Issuable.IssueBuilder	reporter(String reporter) Deprecated. since 5.5, manual issue feature has been dropped.
Issuable.IssueBuilder	ruleKey(RuleKey ruleKey) The rule key is mandatory.
Issuable.IssueBuilder	severity(String severity) Overrides the severity declared in Quality profile.

Method Detail

ruleKey

Issuable.IssueBuilder ruleKey(RuleKey ruleKey)

The rule key is mandatory. Example: RuleKey.of("pmd", "AvoidArrayLoops")

line

@Deprecated
Issuable.IssueBuilder line(@Nullable
                                    Integer line)

Deprecated. since 5.2 use at(NewIssueLocation)

Optional line index, starting from 1. It must not be zero or negative.

message

@Deprecated
Issuable.IssueBuilder message(@Nullable
                                       String message)

Deprecated. since 5.2 use at(NewIssueLocation)

Optional, but recommended, plain-text message.
Formats like Markdown or HTML are not supported. Size must not be greater than Issue.MESSAGE_MAX_SIZE characters.

newLocation

NewIssueLocation newLocation()

Since:

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

at

Issuable.IssueBuilder at(NewIssueLocation primaryLocation)

Since:

5.2 Register primary location for this issue.

addLocation

Issuable.IssueBuilder addLocation(NewIssueLocation secondaryLocation)

Since:

5.2

See Also:

NewIssue.addLocation(NewIssueLocation)

addFlow

Issuable.IssueBuilder addFlow(Iterable<NewIssueLocation> flowLocations)

Since:

5.2

See Also:

NewIssue.addFlow(Iterable)

severity

Issuable.IssueBuilder severity(@Nullable
                             String severity)

Overrides the severity declared in Quality profile. Do not execute in standard use-cases.

See Also:

Severity

reporter

@Deprecated
@CheckForNull
Issuable.IssueBuilder reporter(@Nullable
                                                     String reporter)

Deprecated. since 5.5, manual issue feature has been dropped.

effortToFix

Issuable.IssueBuilder effortToFix(@Nullable
                                Double d)

attribute

Issuable.IssueBuilder attribute(String key,
                              @Nullable
                              String value)

No more supported from batch side since 5.2

build

Issue build()