/*******************************************************************************
* Copyright (c) 2011 GitHub Inc.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Kevin Sawicki (GitHub Inc.) - initial API and implementation
*******************************************************************************/
package org.eclipse.egit.github.core.service;
import static org.eclipse.egit.github.core.client.IGitHubConstants.SEGMENT_ISSUES;
import static org.eclipse.egit.github.core.client.IGitHubConstants.SEGMENT_LABELS;
import static org.eclipse.egit.github.core.client.IGitHubConstants.SEGMENT_REPOS;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import java.util.List;
import org.eclipse.egit.github.core.IRepositoryIdProvider;
import org.eclipse.egit.github.core.Label;
import org.eclipse.egit.github.core.client.GitHubClient;
import org.eclipse.egit.github.core.client.GitHubRequest;
import org.eclipse.egit.github.core.client.PagedRequest;
/**
* Label service class for listing {@link Label} objects in use for a given
* repository.
*
* @see <a href="http://developer.github.com/v3/issues/labels">GitHub labels API
* documentation</a>
*/
public class LabelService extends GitHubService {
/**
* Create label service
*/
public LabelService() {
super();
}
/**
* Create label service for client
*
* @param client
*/
public LabelService(GitHubClient client) {
super(client);
}
/**
* Get labels
*
* @param repository
* @return list of labels
* @throws IOException
*/
public List<Label> getLabels(IRepositoryIdProvider repository)
throws IOException {
String repoId = getId(repository);
return getLabels(repoId);
}
/**
* Get labels
*
* @param user
* @param repository
* @return list of labels
* @throws IOException
*/
public List<Label> getLabels(String user, String repository)
throws IOException {
verifyRepository(user, repository);
String repoId = user + '/' + repository;
return getLabels(repoId);
}
private List<Label> getLabels(String id) throws IOException {
StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
uri.append('/').append(id);
uri.append(SEGMENT_LABELS);
PagedRequest<Label> request = createPagedRequest();
request.setUri(uri);
request.setType(new TypeToken<List<Label>>() {
}.getType());
return getAll(request);
}
/**
* Set the labels for an issue
*
* @param repository
* @param issueId
* @param labels
* @return list of labels
* @throws IOException
*/
public List<Label> setLabels(IRepositoryIdProvider repository,
String issueId, List<Label> labels) throws IOException {
String repoId = getId(repository);
return setLabels(repoId, issueId, labels);
}
/**
* Set the labels for an issue
*
* @param user
* @param repository
* @param issueId
* @param labels
* @return list of labels
* @throws IOException
*/
public List<Label> setLabels(String user, String repository,
String issueId, List<Label> labels) throws IOException {
verifyRepository(user, repository);
String repoId = user + '/' + repository;
return setLabels(repoId, issueId, labels);
}
private List<Label> setLabels(String id, String issueId, List<Label> labels)
throws IOException {
if (issueId == null)
throw new IllegalArgumentException("Issue id cannot be null"); //$NON-NLS-1$
if (issueId.length() == 0)
throw new IllegalArgumentException("Issue id cannot be empty"); //$NON-NLS-1$
StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
uri.append('/').append(id);
uri.append(SEGMENT_ISSUES);
uri.append('/').append(issueId);
uri.append(SEGMENT_LABELS);
return client.put(uri.toString(), labels, new TypeToken<List<Label>>() {
}.getType());
}
/**
* Create label
*
* @param repository
* @param label
* @return created label
* @throws IOException
*/
public Label createLabel(IRepositoryIdProvider repository, Label label)
throws IOException {
String repoId = getId(repository);
return createLabel(repoId, label);
}
/**
* Create label
*
* @param user
* @param repository
* @param label
* @return created label
* @throws IOException
*/
public Label createLabel(String user, String repository, Label label)
throws IOException {
verifyRepository(user, repository);
String repoId = user + '/' + repository;
return createLabel(repoId, label);
}
private Label createLabel(String id, Label label) throws IOException {
if (label == null)
throw new IllegalArgumentException("Label cannot be null"); //$NON-NLS-1$
StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
uri.append('/').append(id);
uri.append(SEGMENT_LABELS);
return client.post(uri.toString(), label, Label.class);
}
/**
* Get label with given name
*
* @param repository
* @param label
* @return label
* @throws IOException
*/
public Label getLabel(IRepositoryIdProvider repository, String label)
throws IOException {
String repoId = getId(repository);
return getLabel(repoId, label);
}
/**
* Get label with given name
*
* @param user
* @param repository
* @param label
* @return label
* @throws IOException
*/
public Label getLabel(String user, String repository, String label)
throws IOException {
verifyRepository(user, repository);
String repoId = user + '/' + repository;
return getLabel(repoId, label);
}
private Label getLabel(String id, String label) throws IOException {
if (label == null)
throw new IllegalArgumentException("Label cannot be null"); //$NON-NLS-1$
if (label.length() == 0)
throw new IllegalArgumentException("Label cannot be empty"); //$NON-NLS-1$
StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
uri.append('/').append(id);
uri.append(SEGMENT_LABELS);
uri.append('/').append(label);
GitHubRequest request = createRequest();
request.setUri(uri);
request.setType(Label.class);
return (Label) client.get(request).getBody();
}
/**
* Delete a label with the given id from the given repository
*
* @param repository
* @param label
* @throws IOException
*/
public void deleteLabel(IRepositoryIdProvider repository, String label)
throws IOException {
String repoId = getId(repository);
deleteLabel(repoId, label);
}
/**
* Delete a label with the given id from the given repository
*
* @param user
* @param repository
* @param label
* @throws IOException
*/
public void deleteLabel(String user, String repository, String label)
throws IOException {
verifyRepository(user, repository);
String repoId = user + '/' + repository;
deleteLabel(repoId, label);
}
private void deleteLabel(String id, String label) throws IOException {
if (label == null)
throw new IllegalArgumentException("Label cannot be null"); //$NON-NLS-1$
if (label.length() == 0)
throw new IllegalArgumentException("Label cannot be empty"); //$NON-NLS-1$
StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
uri.append('/').append(id);
uri.append(SEGMENT_LABELS);
uri.append('/').append(label);
client.delete(uri.toString());
}
/**
* Edit the given label in the given repository
*
* @param repository
* @param label
* @return edited label
* @throws IOException
*/
public Label editLabel(IRepositoryIdProvider repository, Label label)
throws IOException {
String repoId = getId(repository);
if (label == null)
throw new IllegalArgumentException("Label cannot be null"); //$NON-NLS-1$
String name = label.getName();
if (name == null)
throw new IllegalArgumentException("Label name cannot be null"); //$NON-NLS-1$
if (name.length() == 0)
throw new IllegalArgumentException("Label name cannot be empty"); //$NON-NLS-1$
StringBuilder uri = new StringBuilder(SEGMENT_REPOS);
uri.append('/').append(repoId);
uri.append(SEGMENT_LABELS);
uri.append('/').append(name);
return client.post(uri.toString(), label, Label.class);
}
}