From d668912d86c5120c3c6eb384e249a93196eaa12b Mon Sep 17 00:00:00 2001 From: Greg Messner Date: Wed, 20 May 2015 18:12:28 -0700 Subject: [PATCH] Cleaned up formatting. --- .../messners/gitlab/api/RepositoryApi.java | 281 +++++++++--------- 1 file changed, 139 insertions(+), 142 deletions(-) diff --git a/src/main/java/com/messners/gitlab/api/RepositoryApi.java b/src/main/java/com/messners/gitlab/api/RepositoryApi.java index 4d8d8e45..131296a6 100644 --- a/src/main/java/com/messners/gitlab/api/RepositoryApi.java +++ b/src/main/java/com/messners/gitlab/api/RepositoryApi.java @@ -9,7 +9,6 @@ import javax.ws.rs.core.GenericType; import javax.ws.rs.core.Response; import java.util.List; - /** * This class provides an entry point to all the GitLab API repository calls. * @@ -17,125 +16,120 @@ import java.util.List; */ public class RepositoryApi extends AbstractApi { - public RepositoryApi (GitLabApi gitLabApi) { - super(gitLabApi); - } - - - /** - * Get a list of repository branches from a project, sorted by name alphabetically. - * - * GET /projects/:id/repository/branches - * - * @param projectId - * @return the list of repository branches for mthe specified project ID - * @throws GitLabApiException - */ - public List getBranches (Integer projectId) throws GitLabApiException { - Response response = get(Response.Status.OK, null, "projects", projectId, "repository", "branches"); - return (response.readEntity(new GenericType>() {})); - } - + public RepositoryApi(GitLabApi gitLabApi) { + super(gitLabApi); + } - /** - * Get a single project repository branch. - * - * GET /projects/:id/repository/branches/:branch - * - * @param projectId - * @param branchName - * @return the branch info for the specified project ID/branch name pair - * @throws GitLabApiException - */ - public Branch getBranch (Integer projectId, String branchName) throws GitLabApiException { - Response response = get(Response.Status.OK, null, "projects", projectId, "repository", "branches", branchName); - return (response.readEntity(Branch.class)); - } + /** + * Get a list of repository branches from a project, sorted by name alphabetically. + * + * GET /projects/:id/repository/branches + * + * @param projectId + * @return the list of repository branches for mthe specified project ID + * @throws GitLabApiException + */ + public List getBranches(Integer projectId) throws GitLabApiException { + Response response = get(Response.Status.OK, null, "projects", projectId, "repository", "branches"); + return (response.readEntity(new GenericType>() { + })); + } + /** + * Get a single project repository branch. + * + * GET /projects/:id/repository/branches/:branch + * + * @param projectId + * @param branchName + * @return the branch info for the specified project ID/branch name pair + * @throws GitLabApiException + */ + public Branch getBranch(Integer projectId, String branchName) throws GitLabApiException { + Response response = get(Response.Status.OK, null, "projects", projectId, "repository", "branches", branchName); + return (response.readEntity(Branch.class)); + } - /** - * Creates a branch for the project. Support as of version 6.8.x - * - * POST /projects/:id/repository/branches - * - * @param projectId the project to create the branch for - * @param branchName the name of the branch to create - * @param ref Source to create the branch from, can be an existing branch, tag or commit SHA - * @return the branch info for the created branch - * @throws GitLabApiException - */ - public Branch createBranch (Integer projectId, String branchName, String ref) throws GitLabApiException { + /** + * Creates a branch for the project. Support as of version 6.8.x + * + * POST /projects/:id/repository/branches + * + * @param projectId the project to create the branch for + * @param branchName the name of the branch to create + * @param ref Source to create the branch from, can be an existing branch, tag or commit SHA + * @return the branch info for the created branch + * @throws GitLabApiException + */ + public Branch createBranch(Integer projectId, String branchName, String ref) throws GitLabApiException { Form formData = new Form(); formData.param("branch_name ", branchName); formData.param("ref ", ref); Response response = post(Response.Status.OK, formData, "projects", projectId, "repository", "branches"); return (response.readEntity(Branch.class)); } - - - /** - * Protects a single project repository branch. This is an idempotent function, - * protecting an already protected repository branch will not produce an error. - * - * PUT /projects/:id/repository/branches/:branch/protect - * - * @param projectId - * @param branchName - * @return the branch info for the protected branch - * @throws GitLabApiException - */ - public Branch protectBranch (Integer projectId, String branchName) throws GitLabApiException { - Response response = put(Response.Status.OK, null, "projects", projectId, "repository", "branches", branchName, "protect"); - return (response.readEntity(Branch.class)); - } - - - /** - * Unprotects a single project repository branch. This is an idempotent function, unprotecting an - * already unprotected repository branch will not produce an error. - * - * PUT /projects/:id/repository/branches/:branch/unprotect - * - * @param projectId - * @param branchName - * @return the branch info for the unprotected branch - * @throws GitLabApiException - */ - public Branch unprotectBranch (Integer projectId, String branchName) throws GitLabApiException { - Response response = put(Response.Status.OK, null, "projects", projectId, "repository", "branches", branchName, "unprotect"); - return (response.readEntity(Branch.class)); - } - - - /** - * Get a list of repository tags from a project, sorted by name in reverse alphabetical order. - * - * GET /projects/:id/repository/tags - * - * @param projectId - * @return the list of tags for the specified project ID - * @throws GitLabApiException - */ - public List getTags (Integer projectId) throws GitLabApiException { - Response response = put(Response.Status.OK, null, "projects", projectId, "repository", "tags"); - return (response.readEntity(new GenericType>() {})); - } - - - /** - * Get a list of repository files and directories in a project. - * - * GET /projects/:id/repository/tree - * - * @param projectId - * @return a tree with the root directories and files of a project - * @throws GitLabApiException - */ - public List getTree (Integer projectId) throws GitLabApiException { - return this.getTree(projectId, "/", "master"); - } - /** + /** + * Protects a single project repository branch. This is an idempotent function, + * protecting an already protected repository branch will not produce an error. + * + * PUT /projects/:id/repository/branches/:branch/protect + * + * @param projectId + * @param branchName + * @return the branch info for the protected branch + * @throws GitLabApiException + */ + public Branch protectBranch(Integer projectId, String branchName) throws GitLabApiException { + Response response = put(Response.Status.OK, null, "projects", projectId, "repository", "branches", branchName, "protect"); + return (response.readEntity(Branch.class)); + } + + /** + * Unprotects a single project repository branch. This is an idempotent function, unprotecting an + * already unprotected repository branch will not produce an error. + * + * PUT /projects/:id/repository/branches/:branch/unprotect + * + * @param projectId + * @param branchName + * @return the branch info for the unprotected branch + * @throws GitLabApiException + */ + public Branch unprotectBranch(Integer projectId, String branchName) throws GitLabApiException { + Response response = put(Response.Status.OK, null, "projects", projectId, "repository", "branches", branchName, "unprotect"); + return (response.readEntity(Branch.class)); + } + + /** + * Get a list of repository tags from a project, sorted by name in reverse alphabetical order. + * + * GET /projects/:id/repository/tags + * + * @param projectId + * @return the list of tags for the specified project ID + * @throws GitLabApiException + */ + public List getTags(Integer projectId) throws GitLabApiException { + Response response = put(Response.Status.OK, null, "projects", projectId, "repository", "tags"); + return (response.readEntity(new GenericType>() { + })); + } + + /** + * Get a list of repository files and directories in a project. + * + * GET /projects/:id/repository/tree + * + * @param projectId + * @return a tree with the root directories and files of a project + * @throws GitLabApiException + */ + public List getTree(Integer projectId) throws GitLabApiException { + return this.getTree(projectId, "/", "master"); + } + + /** * Get a list of repository files and directories in a project. * * GET /projects/:id/repository/tree @@ -143,49 +137,52 @@ public class RepositoryApi extends AbstractApi { * id (required) - The ID of a project * path (optional) - The path inside repository. Used to get contend of subdirectories * ref_name (optional) - The name of a repository branch or tag or if not given the default branch + * + * @param projectId + * @param filePath + * @param refName * @return a tree with the directories and files of a project * @throws GitLabApiException */ - public List getTree (Integer projectId, String filePath, String refName) throws GitLabApiException { + public List getTree(Integer projectId, String filePath, String refName) throws GitLabApiException { Form formData = new Form(); addFormParam(formData, "id", projectId, true); addFormParam(formData, "path", filePath, false); addFormParam(formData, "ref_name", refName, false); Response response = get(Response.Status.OK, formData.asMap(), "projects", projectId, "repository", "tree"); - return (response.readEntity(new GenericType>() {})); + return (response.readEntity(new GenericType>() { + })); } + /** + * Get the raw file contents for a file by commit sha and path. + * + * GET /projects/:id/repository/blobs/:sha + * + * @param projectId + * @param commitOrBranchName + * @return a string with the file content for the specified file + * @throws GitLabApiException + */ + public String getRawFileContent(Integer projectId, String commitOrBranchName, String filepath) throws GitLabApiException { + Form formData = new Form(); + addFormParam(formData, "filepath", filepath, true); + Response response = get(Response.Status.OK, formData.asMap(), "projects", projectId, "repository", "blobs", commitOrBranchName); + return (response.readEntity(String.class)); + } - /** - * Get the raw file contents for a file by commit sha and path. - * - * GET /projects/:id/repository/blobs/:sha - * - * @param projectId - * @param commitOrBranchName - * @return a string with the file content for the specified file - * @throws GitLabApiException - */ - public String getRawFileContent (Integer projectId, String commitOrBranchName, String filepath) throws GitLabApiException { - Form formData = new Form(); - addFormParam(formData, "filepath", filepath, true); - Response response = get(Response.Status.OK, formData.asMap(), "projects", projectId, "repository", "blobs", commitOrBranchName); - return (response.readEntity(String.class)); - } - - - /** - * Get the raw file contents for a blob by blob SHA. - * - * GET /projects/:id/repository/raw_blobs/:sha - * - * @param projectId - * @param sha - * @return the raw file contents for the blob - * @throws GitLabApiException - */ - public String getRawBlobCotent(Integer projectId, String sha) throws GitLabApiException{ + /** + * Get the raw file contents for a blob by blob SHA. + * + * GET /projects/:id/repository/raw_blobs/:sha + * + * @param projectId + * @param sha + * @return the raw file contents for the blob + * @throws GitLabApiException + */ + public String getRawBlobCotent(Integer projectId, String sha) throws GitLabApiException { Response response = get(Response.Status.OK, null, "projects", projectId, "repository", "raw_blobs", sha); return (response.readEntity(String.class)); - } + } } -- GitLab