aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-plugin-api
diff options
context:
space:
mode:
authorSimon Brandhof <simon.brandhof@gmail.com>2013-04-19 13:39:23 +0200
committerSimon Brandhof <simon.brandhof@gmail.com>2013-04-19 13:50:58 +0200
commit7f8c6bc89dbc2f5a1792b17228b1a17b2c8483d6 (patch)
tree82db25d1945e42e1b11d274f8d8784feb957f731 /sonar-plugin-api
parent455c2922640c42a504caf3e32beb38ba5c64905b (diff)
downloadsonarqube-7f8c6bc89dbc2f5a1792b17228b1a17b2c8483d6.tar.gz
sonarqube-7f8c6bc89dbc2f5a1792b17228b1a17b2c8483d6.zip
SONAR-3755 rename Issue#message() to description()
Diffstat (limited to 'sonar-plugin-api')
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/issue/Issuable.java2
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/issue/Issue.java5
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueChange.java20
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueChanges.java2
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueFinder.java2
-rw-r--r--sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueQuery.java20
-rw-r--r--sonar-plugin-api/src/test/java/org/sonar/api/issue/IssueChangeTest.java6
-rw-r--r--sonar-plugin-api/src/test/java/org/sonar/api/issue/IssueQueryTest.java4
8 files changed, 30 insertions, 31 deletions
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issuable.java b/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issuable.java
index cfaaacde6f9..f38a9078115 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issuable.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issuable.java
@@ -35,7 +35,7 @@ public interface Issuable extends Perspective {
IssueBuilder line(Integer line);
- IssueBuilder message(String message);
+ IssueBuilder description(String description);
IssueBuilder title(String title);
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issue.java b/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issue.java
index 5e57ae74039..342e7792e7a 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issue.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/issue/Issue.java
@@ -29,6 +29,7 @@ import java.util.Map;
*/
public interface Issue {
+ int DESCRIPTION_MAX_SIZE = 4000;
String STATUS_OPEN = "OPEN";
String STATUS_REOPENED = "REOPENED";
String STATUS_RESOLVED = "RESOLVED";
@@ -50,7 +51,7 @@ public interface Issue {
String title();
- String message();
+ String description();
Integer line();
@@ -62,7 +63,7 @@ public interface Issue {
String userLogin();
- String assigneeLogin();
+ String assignee();
Date createdAt();
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueChange.java b/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueChange.java
index 572a4d8dd40..c83dd0e1d80 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueChange.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueChange.java
@@ -33,13 +33,13 @@ public class IssueChange {
private String comment = null;
private String commentLogin = null;
private Boolean manualSeverity = null;
- private String message = null;
+ private String description = null;
private boolean lineChanged = false;
private Integer line = null;
private boolean costChanged = false;
private Double cost = null;
private String resolution = null;
- private boolean assigneeLoginChanged = false;
+ private boolean assigneeChanged = false;
private String assignee = null;
private Map<String, String> attributes = null;
@@ -51,8 +51,8 @@ public class IssueChange {
}
public boolean hasChanges() {
- return severity != null || comment != null || manualSeverity != null || message != null ||
- lineChanged || costChanged || resolution != null || assigneeLoginChanged || attributes != null;
+ return severity != null || comment != null || manualSeverity != null || description != null ||
+ lineChanged || costChanged || resolution != null || assigneeChanged || attributes != null;
}
public IssueChange setSeverity(String s) {
@@ -75,8 +75,8 @@ public class IssueChange {
return this;
}
- public IssueChange setMessage(String message) {
- this.message = message;
+ public IssueChange setDescription(String s) {
+ this.description = s;
return this;
}
@@ -98,7 +98,7 @@ public class IssueChange {
}
public IssueChange setAssignee(@Nullable String assigneeLogin) {
- this.assigneeLoginChanged = true;
+ this.assigneeChanged = true;
this.assignee = assigneeLogin;
return this;
}
@@ -127,8 +127,8 @@ public class IssueChange {
return manualSeverity;
}
- public String message() {
- return message;
+ public String description() {
+ return description;
}
public Integer line() {
@@ -156,7 +156,7 @@ public class IssueChange {
}
public boolean isAssigneeChanged() {
- return assigneeLoginChanged;
+ return assigneeChanged;
}
public Map<String, String> attributes() {
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueChanges.java b/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueChanges.java
index 260d377b449..e00ba81114f 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueChanges.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueChanges.java
@@ -28,7 +28,7 @@ import javax.annotation.Nullable;
* Change existing issues
* @since 3.6
*/
-public interface IssueChanges extends BatchComponent, ServerComponent {
+public interface IssueChanges extends BatchComponent {
Issue apply(Issue issue, IssueChange change);
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueFinder.java b/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueFinder.java
index 0377194db41..10d676da834 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueFinder.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueFinder.java
@@ -37,7 +37,7 @@ public interface IssueFinder extends ServerComponent {
List<Issue> issues();
}
- Results find(IssueQuery query, @Nullable Integer currentUserId);
+ Results find(IssueQuery query, @Nullable Integer currentUserId, String role);
Issue findByKey(String key /* TODO @Nullable Integer currentUserId */);
/*
diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueQuery.java b/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueQuery.java
index 0071a574d9f..58600ee03b3 100644
--- a/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueQuery.java
+++ b/sonar-plugin-api/src/main/java/org/sonar/api/issue/IssueQuery.java
@@ -24,8 +24,6 @@ import com.google.common.base.Preconditions;
import org.apache.commons.lang.builder.ReflectionToStringBuilder;
import org.sonar.api.rule.RuleKey;
-import javax.annotation.Nullable;
-
import java.util.Collection;
import java.util.Date;
@@ -44,7 +42,7 @@ public class IssueQuery {
private final Collection<String> componentRoots;
private final Collection<RuleKey> rules;
private final Collection<String> userLogins;
- private final Collection<String> assigneeLogins;
+ private final Collection<String> assignees;
private final Date createdAfter;
private final Date createdBefore;
private final int limit, offset;
@@ -58,7 +56,7 @@ public class IssueQuery {
this.componentRoots = builder.componentRoots;
this.rules = builder.rules;
this.userLogins = builder.userLogins;
- this.assigneeLogins = builder.assigneeLogins;
+ this.assignees = builder.assignees;
this.createdAfter = builder.createdAfter;
this.createdBefore = builder.createdBefore;
this.limit = builder.limit;
@@ -97,8 +95,8 @@ public class IssueQuery {
return userLogins;
}
- public Collection<String> assigneeLogins() {
- return assigneeLogins;
+ public Collection<String> assignees() {
+ return assignees;
}
public Date createdAfter() {
@@ -143,7 +141,7 @@ public class IssueQuery {
private Collection<String> componentRoots;
private Collection<RuleKey> rules;
private Collection<String> userLogins;
- private Collection<String> assigneeLogins;
+ private Collection<String> assignees;
private Date createdAfter;
private Date createdBefore;
private int limit = DEFAULT_LIMIT;
@@ -192,8 +190,8 @@ public class IssueQuery {
return this;
}
- public Builder assigneeLogins(Collection<String> l) {
- this.assigneeLogins = l;
+ public Builder assignees(Collection<String> l) {
+ this.assignees = l;
return this;
}
@@ -207,14 +205,14 @@ public class IssueQuery {
return this;
}
- public Builder limit(@Nullable Integer i) {
+ public Builder limit(Integer i) {
Preconditions.checkArgument(i == null || i.intValue() > 0, "Limit must be greater than 0 (got " + i + ")");
Preconditions.checkArgument(i == null || i.intValue() < MAX_LIMIT, "Limit must be less than " + MAX_LIMIT + " (got " + i + ")");
this.limit = (i == null ? DEFAULT_LIMIT : i.intValue());
return this;
}
- public Builder offset(@Nullable Integer i) {
+ public Builder offset(Integer i) {
Preconditions.checkArgument(i == null || i.intValue() >= 0, "Offset must be greater than or equal to 0 (got " + i + ")");
this.offset = (i == null ? DEFAULT_OFFSET : i.intValue());
return this;
diff --git a/sonar-plugin-api/src/test/java/org/sonar/api/issue/IssueChangeTest.java b/sonar-plugin-api/src/test/java/org/sonar/api/issue/IssueChangeTest.java
index f4dc34f1c96..f74ce695d5d 100644
--- a/sonar-plugin-api/src/test/java/org/sonar/api/issue/IssueChangeTest.java
+++ b/sonar-plugin-api/src/test/java/org/sonar/api/issue/IssueChangeTest.java
@@ -37,7 +37,7 @@ public class IssueChangeTest {
assertThat(change.isLineChanged()).isFalse();
assertThat(change.line()).isNull();
assertThat(change.comment()).isNull();
- assertThat(change.message()).isNull();
+ assertThat(change.description()).isNull();
assertThat(change.resolution()).isNull();
assertThat(change.manualSeverity()).isNull();
assertThat(change.attributes()).isEmpty();
@@ -101,8 +101,8 @@ public class IssueChangeTest {
@Test
public void should_change_message() {
IssueChange change = IssueChange.create();
- change.setMessage("foo");
- assertThat(change.message()).isEqualTo("foo");
+ change.setDescription("foo");
+ assertThat(change.description()).isEqualTo("foo");
assertThat(change.hasChanges()).isTrue();
}
diff --git a/sonar-plugin-api/src/test/java/org/sonar/api/issue/IssueQueryTest.java b/sonar-plugin-api/src/test/java/org/sonar/api/issue/IssueQueryTest.java
index 324d2d78c3c..e7e1bc13597 100644
--- a/sonar-plugin-api/src/test/java/org/sonar/api/issue/IssueQueryTest.java
+++ b/sonar-plugin-api/src/test/java/org/sonar/api/issue/IssueQueryTest.java
@@ -41,7 +41,7 @@ public class IssueQueryTest {
.componentRoots(Lists.newArrayList("org.struts:core"))
.rules(Lists.newArrayList(RuleKey.of("squid", "AvoidCycle")))
.userLogins(Lists.newArrayList("crunky"))
- .assigneeLogins(Lists.newArrayList("gargantua"))
+ .assignees(Lists.newArrayList("gargantua"))
.createdAfter(new Date())
.createdBefore(new Date())
.limit(125)
@@ -54,7 +54,7 @@ public class IssueQueryTest {
assertThat(query.components()).containsOnly("org/struts/Action.java");
assertThat(query.componentRoots()).containsOnly("org.struts:core");
assertThat(query.userLogins()).containsOnly("crunky");
- assertThat(query.assigneeLogins()).containsOnly("gargantua");
+ assertThat(query.assignees()).containsOnly("gargantua");
assertThat(query.rules()).containsOnly(RuleKey.of("squid", "AvoidCycle"));
assertThat(query.createdAfter()).isNotNull();
assertThat(query.createdBefore()).isNotNull();