org.sonar.api.issue.IssueQuery Maven / Gradle / Ivy
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2014 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 com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableSet;
import org.apache.commons.lang.builder.ReflectionToStringBuilder;
import org.sonar.api.rule.RuleKey;
import org.sonar.api.web.UserRole;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.Set;
/**
* @since 3.6
*/
public class IssueQuery {
public static final int DEFAULT_PAGE_INDEX = 1;
public static final int DEFAULT_PAGE_SIZE = 100;
public static final int MAX_RESULTS = 10000;
public static final int MAX_PAGE_SIZE = 500;
/**
* @deprecated since 3.7. It's replaced by IssueQuery#MAX_PAGE_SIZE.
*/
@Deprecated
public static final int MAX_ISSUE_KEYS = MAX_PAGE_SIZE;
public static final String SORT_BY_CREATION_DATE = "CREATION_DATE";
public static final String SORT_BY_UPDATE_DATE = "UPDATE_DATE";
public static final String SORT_BY_CLOSE_DATE = "CLOSE_DATE";
public static final String SORT_BY_ASSIGNEE = "ASSIGNEE";
public static final String SORT_BY_SEVERITY = "SEVERITY";
public static final String SORT_BY_STATUS = "STATUS";
public static final Set SORTS = ImmutableSet.of(SORT_BY_CREATION_DATE, SORT_BY_UPDATE_DATE, SORT_BY_CLOSE_DATE, SORT_BY_ASSIGNEE, SORT_BY_SEVERITY, SORT_BY_STATUS);
private final Collection issueKeys;
private final Collection severities;
private final Collection statuses;
private final Collection resolutions;
private final Collection components;
private final Collection componentRoots;
private final Collection rules;
private final Collection actionPlans;
private final Collection reporters;
private final Collection assignees;
private final Collection languages;
private final Boolean assigned;
private final Boolean planned;
private final Boolean resolved;
private final Boolean hideRules;
private final Date createdAt;
private final Date createdAfter;
private final Date createdBefore;
private final String sort;
private final Boolean asc;
private final String requiredRole;
// max results per page
private final int pageSize;
// index of selected page. Start with 1.
private final int pageIndex;
private IssueQuery(Builder builder) {
this.issueKeys = defaultCollection(builder.issueKeys);
this.severities = defaultCollection(builder.severities);
this.statuses = defaultCollection(builder.statuses);
this.resolutions = defaultCollection(builder.resolutions);
this.components = defaultCollection(builder.components);
this.componentRoots = defaultCollection(builder.componentRoots);
this.rules = defaultCollection(builder.rules);
this.actionPlans = defaultCollection(builder.actionPlans);
this.reporters = defaultCollection(builder.reporters);
this.assignees = defaultCollection(builder.assignees);
this.languages = defaultCollection(builder.languages);
this.assigned = builder.assigned;
this.planned = builder.planned;
this.resolved = builder.resolved;
this.hideRules = builder.hideRules;
this.createdAt = builder.createdAt;
this.createdAfter = builder.createdAfter;
this.createdBefore = builder.createdBefore;
this.sort = builder.sort;
this.asc = builder.asc;
this.pageSize = builder.pageSize;
this.pageIndex = builder.pageIndex;
this.requiredRole = builder.requiredRole;
}
public Collection issueKeys() {
return issueKeys;
}
public Collection severities() {
return severities;
}
public Collection statuses() {
return statuses;
}
public Collection resolutions() {
return resolutions;
}
public Collection components() {
return components;
}
public Collection componentRoots() {
return componentRoots;
}
public Collection rules() {
return rules;
}
public Collection actionPlans() {
return actionPlans;
}
public Collection reporters() {
return reporters;
}
public Collection assignees() {
return assignees;
}
public Collection languages() {
return languages;
}
@CheckForNull
public Boolean assigned() {
return assigned;
}
@CheckForNull
public Boolean planned() {
return planned;
}
@CheckForNull
public Boolean resolved() {
return resolved;
}
/**
* @since 4.2
*/
@CheckForNull
public Boolean hideRules() {
return hideRules;
}
@CheckForNull
public Date createdAfter() {
return createdAfter == null ? null : new Date(createdAfter.getTime());
}
@CheckForNull
public Date createdAt() {
return createdAt == null ? null : new Date(createdAt.getTime());
}
@CheckForNull
public Date createdBefore() {
return createdBefore == null ? null : new Date(createdBefore.getTime());
}
@CheckForNull
public String sort() {
return sort;
}
@CheckForNull
public Boolean asc() {
return asc;
}
public int pageSize() {
return pageSize;
}
public int pageIndex() {
return pageIndex;
}
public int maxResults() {
return MAX_RESULTS;
}
public String requiredRole() {
return requiredRole;
}
@Override
public String toString() {
return ReflectionToStringBuilder.toString(this);
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Collection issueKeys;
private Collection severities;
private Collection statuses;
private Collection resolutions;
private Collection components;
private Collection componentRoots;
private Collection rules;
private Collection actionPlans;
private Collection reporters;
private Collection assignees;
private Collection languages;
private Boolean assigned = null;
private Boolean planned = null;
private Boolean resolved = null;
private Boolean hideRules = false;
private Date createdAt;
private Date createdAfter;
private Date createdBefore;
private String sort;
private Boolean asc = false;
private Integer pageSize;
private Integer pageIndex;
private String requiredRole = UserRole.USER;
private Builder() {
}
public Builder issueKeys(@Nullable Collection l) {
this.issueKeys = l;
return this;
}
public Builder severities(@Nullable Collection l) {
this.severities = l;
return this;
}
public Builder statuses(@Nullable Collection l) {
this.statuses = l;
return this;
}
public Builder resolutions(@Nullable Collection l) {
this.resolutions = l;
return this;
}
public Builder components(@Nullable Collection l) {
this.components = l;
return this;
}
public Builder componentRoots(@Nullable Collection l) {
this.componentRoots = l;
return this;
}
public Builder rules(@Nullable Collection rules) {
this.rules = rules;
return this;
}
public Builder actionPlans(@Nullable Collection l) {
this.actionPlans = l;
return this;
}
public Builder reporters(@Nullable Collection l) {
this.reporters = l;
return this;
}
public Builder assignees(@Nullable Collection l) {
this.assignees = l;
return this;
}
public Builder languages(@Nullable Collection l) {
this.languages = l;
return this;
}
/**
* If true, it will return all issues assigned to someone
* If false, it will return all issues not assigned to someone
*/
public Builder assigned(@Nullable Boolean b) {
this.assigned = b;
return this;
}
/**
* If true, it will return all issues linked to an action plan
* If false, it will return all issues not linked to an action plan
*/
public Builder planned(@Nullable Boolean planned) {
this.planned = planned;
return this;
}
/**
* If true, it will return all resolved issues
* If false, it will return all none resolved issues
*/
public Builder resolved(@Nullable Boolean resolved) {
this.resolved = resolved;
return this;
}
/**
* If true, rules will not be loaded
* If false, rules will be loaded
*
* @since 4.2
*
*/
public Builder hideRules(@Nullable Boolean b) {
this.hideRules = b;
return this;
}
public Builder createdAt(@Nullable Date d) {
this.createdAt = d == null ? null : new Date(d.getTime());
return this;
}
public Builder createdAfter(@Nullable Date d) {
this.createdAfter = d == null ? null : new Date(d.getTime());
return this;
}
public Builder createdBefore(@Nullable Date d) {
this.createdBefore = d == null ? null : new Date(d.getTime());
return this;
}
public Builder sort(@Nullable String s) {
if (s != null && !SORTS.contains(s)) {
throw new IllegalArgumentException("Bad sort field: " + s);
}
this.sort = s;
return this;
}
public Builder asc(@Nullable Boolean asc) {
this.asc = asc;
return this;
}
public Builder pageSize(@Nullable Integer i) {
this.pageSize = i;
return this;
}
public Builder pageIndex(@Nullable Integer i) {
this.pageIndex = i;
return this;
}
public Builder requiredRole(@Nullable String s) {
this.requiredRole = s;
return this;
}
public IssueQuery build() {
initPageIndex();
initPageSize();
if (issueKeys != null) {
Preconditions.checkArgument(issueKeys.size() <= MAX_PAGE_SIZE, "Number of issue keys must be less than " + MAX_PAGE_SIZE + " (got " + issueKeys.size() + ")");
}
return new IssueQuery(this);
}
private void initPageSize() {
if (components != null && components.size() == 1 && pageSize == null) {
pageSize = 999999;
} else {
if (pageSize == null) {
pageSize = DEFAULT_PAGE_SIZE;
} else if (pageSize <= 0 || pageSize > MAX_PAGE_SIZE) {
pageSize = MAX_PAGE_SIZE;
}
}
}
private void initPageIndex() {
if (pageIndex == null) {
pageIndex = DEFAULT_PAGE_INDEX;
}
Preconditions.checkArgument(pageIndex > 0, "Page index must be greater than 0 (got " + pageIndex + ")");
}
}
private static Collection defaultCollection(@Nullable Collection c) {
return c == null ? Collections.emptyList() : Collections.unmodifiableCollection(c);
}
}