MilestonesApi.java

package org.gitlab4j.api;

import java.util.Date;
import java.util.List;
import java.util.stream.Stream;

import jakarta.ws.rs.core.Form;
import jakarta.ws.rs.core.GenericType;
import jakarta.ws.rs.core.Response;

import org.gitlab4j.api.models.Issue;
import org.gitlab4j.api.models.MergeRequest;
import org.gitlab4j.api.models.Milestone;

/**
 * This class implements the client side API for the GitLab milestones calls.
 * @see <a href="https://docs.gitlab.com/ce/api/milestones.html">Project milestones API</a>
 * @see <a href="https://docs.gitlab.com/ce/api/group_milestones.html">Group milestones API</a>
 */
public class MilestonesApi extends AbstractApi {

    public MilestonesApi(GitLabApi gitLabApi) {
        super(gitLabApi);
    }

    /**
     * Get a list of group milestones.
     *
     * <pre><code>GitLab Endpoint: GET /groups/:id/milestones</code></pre>
     *
     * @param groupIdOrPath the group in the form of an Long(ID), String(path), or Group instance
     * @return the milestones associated with the specified group
     * @throws GitLabApiException if any exception occurs
     */
    public List<Milestone> getGroupMilestones(Object groupIdOrPath) throws GitLabApiException {
        return (getGroupMilestones(groupIdOrPath, getDefaultPerPage()).all());
    }

    /**
     * Get a list of group milestones.
     *
     * <pre><code>GitLab Endpoint: GET /groups/:id/milestones</code></pre>
     *
     * @param groupIdOrPath the group in the form of an Long(ID), String(path), or Group instance
     * @param page the page number to get
     * @param perPage how many milestones per page
     * @return the milestones associated with the specified group
     * @throws GitLabApiException if any exception occurs
     */
    public List<Milestone> getGroupMilestones(Object groupIdOrPath, int page, int perPage) throws GitLabApiException {
        Response response = get(Response.Status.OK, getPageQueryParams(page, perPage),
                "groups", getGroupIdOrPath(groupIdOrPath), "milestones");
        return (response.readEntity(new GenericType<List<Milestone>>() {}));
    }

    /**
     * Get a Page of group milestones.
     *
     * <pre><code>GitLab Endpoint: GET /groups/:id/milestones</code></pre>
     *
     * @param groupIdOrPath the group in the form of an Long(ID), String(path), or Group instance
     * @param itemsPerPage The number of Milestone instances that will be fetched per page
     * @return the milestones associated with the specified group
     * @throws GitLabApiException if any exception occurs
     */
    public Pager<Milestone> getGroupMilestones(Object groupIdOrPath, int itemsPerPage) throws GitLabApiException {
        return (new Pager<Milestone>(this, Milestone.class, itemsPerPage, null,
                "groups", getGroupIdOrPath(groupIdOrPath), "milestones"));
    }