org.sonar.wsclient.services.DependencyTreeQuery Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-ws-client Show documentation

Java Client Library for SonarQube Web Services

There is a newer version: 5.1

/*
 * Sonar, open source software quality management tool.
 * Copyright (C) 2008-2012 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * Sonar 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.
 *
 * Sonar 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 Sonar; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package org.sonar.wsclient.services;

/**
 * @since 2.1
 */
public class DependencyTreeQuery extends Query {
  private static final String BASE_URL = "/api/dependency_tree";

  private String resourceId;
  private String[] scopes;

  public DependencyTreeQuery(String resourceId) {
    this.resourceId = resourceId;
  }

  public String getResourceId() {
    return resourceId;
  }

  public String[] getScopes() {
    return scopes;
  }

  public DependencyTreeQuery setResourceId(String resourceId) {
    this.resourceId = resourceId;
    return this;
  }

  public DependencyTreeQuery setScopes(String... scopes) {
    this.scopes = scopes;
    return this;
  }

  @Override
  public String getUrl() {
    StringBuilder url = new StringBuilder(BASE_URL);
    url.append('?');
    appendUrlParameter(url, "resource", resourceId);
    appendUrlParameter(url, "scopes", scopes);
    return url.toString();
  }

  @Override
  public Class getModelClass() {
    return DependencyTree.class;
  }

  public static DependencyTreeQuery createForResource(String resourceIdOrKey) {
    return new DependencyTreeQuery(resourceIdOrKey);
  }

  public static DependencyTreeQuery createForProject(String projectIdOrKey) {
    return new DependencyTreeQuery(projectIdOrKey).setScopes(Resource.SCOPE_SET);
  }
}