Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*********************************************************************************
* *
* The MIT License (MIT) *
* *
* Copyright (c) 2015-2022 aoju.org Greg Messner and other contributors. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a copy *
* of this software and associated documentation files (the "Software"), to deal *
* in the Software without restriction, including without limitation the rights *
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *
* copies of the Software, and to permit persons to whom the Software is *
* furnished to do so, subject to the following conditions: *
* *
* The above copyright notice and this permission notice shall be included in *
* all copies or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN *
* THE SOFTWARE. *
* *
********************************************************************************/
package org.aoju.bus.gitlab;
import org.aoju.bus.gitlab.models.Todo;
import javax.ws.rs.core.Response;
import java.util.List;
import java.util.stream.Stream;
/**
* This class implements the client side API for the GitLab Todos API.
*/
public class TodosApi extends AbstractApi {
public TodosApi(GitLabApi gitLabApi) {
super(gitLabApi);
}
/**
* Get a List of pending todos for the current user.
*
*
GitLab Endpoint: GET /todos
*
* @return a List of pending Todos for the current user
* @throws GitLabApiException if any exception occurs
*/
public List getPendingTodos() throws GitLabApiException {
return (getTodos(null, null, null, null, TodoState.PENDING, null, getDefaultPerPage()).all());
}
/**
* Get a Pager of pending todos for the current user.
*
*
GitLab Endpoint: GET /todos
*
* @param itemsPerPage the number of todo that will be fetched per page
* @return a Pager containing the pending Todos for the current user
* @throws GitLabApiException if any exception occurs
*/
public Pager getPendingTodos(int itemsPerPage) throws GitLabApiException {
return (getTodos(null, null, null, null, TodoState.PENDING, null, itemsPerPage));
}
/**
* Get a Stream of pending todos for the current user.
*
*
GitLab Endpoint: GET /todos
*
* @return a Stream containing the pending Todos for the user
* @throws GitLabApiException if any exception occurs
*/
public Stream getPendingTodosStream() throws GitLabApiException {
return (getTodos(null, null, null, null, TodoState.PENDING, null, getDefaultPerPage()).stream());
}
/**
* Get a List of done todos for the current user.
*
*
GitLab Endpoint: GET /todos
*
* @return a List of done Todos for the current user
* @throws GitLabApiException if any exception occurs
*/
public List getDoneTodos() throws GitLabApiException {
return (getTodos(null, null, null, null, TodoState.DONE, null, getDefaultPerPage()).all());
}
/**
* Get a Pager of done todos for the current user.
*
*
GitLab Endpoint: GET /todos
*
* @param itemsPerPage the number of todo that will be fetched per page
* @return a Pager containing the done Todos for the current user
* @throws GitLabApiException if any exception occurs
*/
public Pager getDoneTodos(int itemsPerPage) throws GitLabApiException {
return (getTodos(null, null, null, null, TodoState.DONE, null, itemsPerPage));
}
/**
* Get a Stream of done todos for the current user.
*
*
GitLab Endpoint: GET /todos
*
* @return a Stream containing the done Todos for the current user
* @throws GitLabApiException if any exception occurs
*/
public Stream getDoneTodosStream() throws GitLabApiException {
return (getTodos(null, null, null, null, TodoState.DONE, null, getDefaultPerPage()).stream());
}
/**
* Get a List of all todos that match the provided filter params.
*
*
GitLab Endpoint: GET /todos
*
* @param action the action to be filtered. Can be assigned, mentioned, build_failed, marked, approval_required, unmergeable or directly_addressed.
* @param authorId the ID of an author
* @param projectId the ID of a project
* @param groupId the ID of a group
* @param state the state of the todo. Can be either pending or done
* @param type the type of a todo. Can be either Issue or MergeRequest
* @return Stream of Todo instances
* @throws GitLabApiException if any exception occurs
*/
public List getTodos(TodoAction action, Long authorId, Long projectId, Long groupId, TodoState state, TodoType type) throws GitLabApiException {
return (getTodos(action, authorId, projectId, groupId, state, type, getDefaultPerPage()).all());
}
/**
* Get a List of all todos that match the provided filter params.
*
*
GitLab Endpoint: GET /todos
*
* @param action the action to be filtered. Can be assigned, mentioned, build_failed, marked, approval_required, unmergeable or directly_addressed.
* @param authorId the ID of an author
* @param projectId the ID of a project
* @param groupId the ID of a group
* @param state the state of the todo. Can be either pending or done
* @param type the type of a todo. Can be either Issue or MergeRequest
* @return Stream of Todo instances
* @throws GitLabApiException if any exception occurs
*/
public Stream getTodosStream(TodoAction action, Long authorId, Long projectId, Long groupId, TodoState state, TodoType type) throws GitLabApiException {
return (getTodos(action, authorId, projectId, groupId, state, type, getDefaultPerPage()).stream());
}
/**
* Returns a Pager of todos that match the provided filter params. When no filter params are provided,
* will returns all pending todos for the current user.
*
*
GitLab Endpoint: GET /todos
*
* @param action the action to be filtered. Can be assigned, mentioned, build_failed, marked, approval_required,
* unmergeable or directly_addressed.
* @param authorId the ID of an author
* @param projectId the ID of a project
* @param groupId the ID of a group
* @param state the state of the todo. Can be either pending or done
* @param type the type of a todo. Can be either Issue or MergeRequest
* @param itemsPerPage the number of todo that will be fetched per page
* @return a list of pages in todo for the specified range
* @throws GitLabApiException if any exception occurs
*/
public Pager getTodos(TodoAction action, Long authorId, Long projectId, Long groupId, TodoState state, TodoType type, int itemsPerPage) throws GitLabApiException {
GitLabApiForm formData = new GitLabApiForm()
.withParam("action", action, false)
.withParam("author_id", authorId, false)
.withParam("project_id", projectId, false)
.withParam("group_id", groupId, false)
.withParam("state", state, false)
.withParam("type", type, false);
return (new Pager(this, Todo.class, itemsPerPage, formData.asMap(), "todos"));
}
/**
* Marks a single pending todo given by its ID for the current user as done.
* The todo marked as done is returned in the response.
*
*
GitLab Endpoint: POST /todos/:id/mark_as_done
*
* @param todoId the ID of a todo
* @return todo instance with info on the created page
* @throws GitLabApiException if any exception occurs
*/
public Todo markAsDone(Long todoId) throws GitLabApiException {
GitLabApiForm formData = new GitLabApiForm();
Response response = post(Response.Status.OK, formData, "todos", todoId, "mark_as_done");
return (response.readEntity(Todo.class));
}
/**
* Marks all pending todos for the current user as done.
*
*
GitLab Endpoint: POST /todos/mark_as_done
*
* @throws GitLabApiException if any exception occurs
*/
public void markAllAsDone() throws GitLabApiException {
GitLabApiForm formData = new GitLabApiForm();
post(Response.Status.NO_CONTENT, formData, "todos", "mark_as_done");
}
}
