aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issuable.java
blob: cab1cc90818f3e3943ad844b2d7220f1c20620a1 (plain)
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
/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2013 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube 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.
 *
 * SonarQube 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 org.sonar.api.component.Perspective;
import org.sonar.api.rule.RuleKey;

import javax.annotation.Nullable;
import java.util.List;

/**
 * @since 3.6
 */
public interface Issuable extends Perspective {

  interface IssueBuilder {
    IssueBuilder ruleKey(RuleKey ruleKey);

    IssueBuilder line(@Nullable Integer line);

    IssueBuilder message(@Nullable String message);

    IssueBuilder severity(@Nullable String severity);

    IssueBuilder reporter(@Nullable String reporter);

    IssueBuilder effortToFix(@Nullable Double d);

    IssueBuilder attribute(String key, @Nullable String value);

    Issue build();
  }

  IssueBuilder newIssueBuilder();

  /**
   * @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);

  /**
   * The issues that are not resolved (=open). They include the manual issues reported by end-users.
   */
  List<Issue> issues();

  /**
   * The issues marked as resolved during this scan.
   */
  List<Issue> resolvedIssues();
}