1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
/*
* SonarQube
* Copyright (C) 2009-2016 SonarSource SA
* mailto:contact AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.issue;
import java.util.List;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.sonar.api.batch.sensor.issue.NewIssue;
import org.sonar.api.batch.sensor.issue.NewIssueLocation;
import org.sonar.api.component.Perspective;
import org.sonar.api.rule.RuleKey;
/**
* This perspective allows to add issues related to the selected component. It can be used from
* {@link org.sonar.api.batch.Sensor}s.
* <br>
* Example:
* <pre>
* 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);
* }
* }
* }
* </pre>
* @since 3.6
*/
public interface Issuable extends Perspective {
interface IssueBuilder {
/**
* The rule key is mandatory. Example: {@code RuleKey.of("pmd", "AvoidArrayLoops")}
*/
IssueBuilder ruleKey(RuleKey ruleKey);
/**
* Optional line index, starting from 1. It must not be zero or negative.
* @deprecated since 5.2 use {@link #at(NewIssueLocation)}
*/
@Deprecated
IssueBuilder line(@Nullable Integer line);
/**
* Optional, but recommended, plain-text message.
* <br>
* Formats like Markdown or HTML are not supported. Size must not be greater than {@link Issue#MESSAGE_MAX_SIZE} characters.
* @deprecated since 5.2 use {@link #at(NewIssueLocation)}
*/
@Deprecated
IssueBuilder message(@Nullable String message);
/**
* @since 5.2
* Create a new location for this issue. First registered location is considered as primary location.
*/
NewIssueLocation newLocation();
/**
* @since 5.2
* Register primary location for this issue.
*/
IssueBuilder at(NewIssueLocation primaryLocation);
/**
* @since 5.2
* @see NewIssue#addLocation(NewIssueLocation)
*/
IssueBuilder addLocation(NewIssueLocation secondaryLocation);
/**
* @since 5.2
* @see NewIssue#addFlow(Iterable)
*/
IssueBuilder addFlow(Iterable<NewIssueLocation> flowLocations);
/**
* Overrides the severity declared in Quality profile. Do not execute in standard use-cases.
* @see org.sonar.api.rule.Severity
*/
IssueBuilder severity(@Nullable String severity);
/**
* @deprecated since 5.5, manual issue feature has been dropped.
*/
@Deprecated
@CheckForNull
IssueBuilder reporter(@Nullable String reporter);
IssueBuilder effortToFix(@Nullable Double d);
/**
* No more supported from batch side since 5.2
*/
IssueBuilder attribute(String key, @Nullable String value);
Issue build();
}
/**
* Builder is used to create the issue to be passed to {@link #addIssue(Issue)}
*/
IssueBuilder newIssueBuilder();
/**
* Register an issue created with {@link #newIssueBuilder()}.
* <br>
* This method is usually called from {@link org.sonar.api.batch.Sensor}s. {@link org.sonar.api.batch.Decorator}s calling this
* method must be annotated with {@code @DependedUpon(DecoratorBarriers.ISSUES_ADDED)}.
*
* @return true if the new issue is registered, false if the related rule does not exist or is disabled in the Quality profile.
*/
boolean addIssue(Issue issue);
/**
* @deprecated since 5.2 no more decorators on batch side
*/
@Deprecated
List<Issue> issues();
/**
* @deprecated since 5.2 no more decorators on batch side
*/
@Deprecated
List<Issue> resolvedIssues();
}
|
