Added getXxxxx() methods that return Java 8 Streams.

Author: gmessner

src/main/java/org/gitlab4j/api/GroupApi.java

@@ -1794,7 +1794,7 @@ public ProjectHook modifyHook(ProjectHook hook) throws GitLabApiException {
      * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
      * @return a list of project's issues
      * @throws GitLabApiException if any exception occurs
-     * @deprecated Will be removed in version 5.0, replaced by {@link IssuesApi#getIssues(Integer)}
+     * @deprecated Will be removed in version 5.0, replaced by {@link IssuesApi#getIssues(Object)}
      */
     @Deprecated
     public List<Issue> getIssues(Object projectIdOrPath) throws GitLabApiException {
@@ -1811,7 +1811,7 @@ public List<Issue> getIssues(Object projectIdOrPath) throws GitLabApiException {
      * @param perPage the number of issues per page
      * @return the list of issues in the specified range
      * @throws GitLabApiException if any exception occurs
-     * @deprecated Will be removed in version 5.0, replaced by {@link IssuesApi#getIssues(Integer, int, int)}
+     * @deprecated Will be removed in version 5.0, replaced by {@link IssuesApi#getIssues(Object, int, int)}
      */
     @Deprecated
     public List<Issue> getIssues(Object projectIdOrPath, int page, int perPage) throws GitLabApiException {
@@ -1828,7 +1828,7 @@ public List<Issue> getIssues(Object projectIdOrPath, int page, int perPage) thro
      * @param itemsPerPage the number of issues per page
      * @return the list of issues in the specified range
      * @throws GitLabApiException if any exception occurs
-     * @deprecated Will be removed in version 5.0, replaced by {@link IssuesApi#getIssues(Integer, int)}
+     * @deprecated Will be removed in version 5.0, replaced by {@link IssuesApi#getIssues(Object, int)}
      */
     @Deprecated
     public Pager<Issue> getIssues(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException {
@@ -1843,7 +1843,7 @@ public Pager<Issue> getIssues(Object projectIdOrPath, int itemsPerPage) throws G
      * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
      * @return a Stream of the project's issues
      * @throws GitLabApiException if any exception occurs
-     * @deprecated Will be removed in version 5.0, replaced by {@link IssuesApi#getIssues(Integer)}
+     * @deprecated Will be removed in version 5.0, replaced by {@link IssuesApi#getIssues(Object)}
      */
     @Deprecated
     public Stream<Issue> getIssuesStream(Object projectIdOrPath) throws GitLabApiException {
@@ -1859,7 +1859,7 @@ public Stream<Issue> getIssuesStream(Object projectIdOrPath) throws GitLabApiExc
      * @param issueId the internal ID of a project's issue
      * @return the specified Issue instance
      * @throws GitLabApiException if any exception occurs
-     * @deprecated  Will be removed in version 5.0, replaced by {@link IssuesApi#getIssue(Integer, Integer)}
+     * @deprecated  Will be removed in version 5.0, replaced by {@link IssuesApi#getIssue(Object, Integer)}
      */
     @Deprecated
     public Issue getIssue(Object projectIdOrPath, Integer issueId) throws GitLabApiException {
@@ -1875,7 +1875,7 @@ public Issue getIssue(Object projectIdOrPath, Integer issueId) throws GitLabApiE
      * @param projectIdOrPath projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance, required
      * @param issueId the internal ID of a project's issue
      * @throws GitLabApiException if any exception occurs
-     * @deprecated  Will be removed in version 5.0, replaced by {@link IssuesApi#deleteIssue(Integer, Integer)}
+     * @deprecated  Will be removed in version 5.0, replaced by {@link IssuesApi#deleteIssue(Object, Integer)}
      */
     @Deprecated
     public void deleteIssue(Object projectIdOrPath, Integer issueId) throws GitLabApiException {
@@ -2398,8 +2398,8 @@ public Project transferProject(Object projectIdOrPath, String namespace) throws
      * @return the updated Project instance
      * @throws GitLabApiException if any exception occurs
      */
-    public Project setProjectAvatar(Object projectIdOrPath, File fileToUpload) throws GitLabApiException {
-        return (setProjectAvatar(projectIdOrPath, fileToUpload, null));
+    public Project setProjectAvatar(Object projectIdOrPath, File avatarFile) throws GitLabApiException {
+        return (setProjectAvatar(projectIdOrPath, avatarFile, null));
     }
 
     /**

src/main/java/org/gitlab4j/api/IssuesApi.java

@@ -7,6 +7,7 @@
 import java.nio.file.StandardCopyOption;
 import java.util.List;
 import java.util.Optional;
+import java.util.stream.Stream;
 
 import javax.ws.rs.core.Form;
 import javax.ws.rs.core.GenericType;
@@ -40,9 +41,7 @@ public RepositoryApi(GitLabApi gitLabApi) {
      * @throws GitLabApiException if any exception occurs
      */
     public List<Branch> getBranches(Object projectIdOrPath) throws GitLabApiException {
-        Response response = get(Response.Status.OK, getDefaultPerPageParam(),
-                "projects", getProjectIdOrPath(projectIdOrPath), "repository", "branches");
-        return (response.readEntity(new GenericType<List<Branch>>() {}));
+        return (getBranches(projectIdOrPath, getDefaultPerPage()).all());
     }
 
     /**
@@ -78,6 +77,19 @@ public Pager<Branch> getBranches(Object projectIdOrPath, int itemsPerPage) throw
                 getProjectIdOrPath(projectIdOrPath), "repository", "branches"));
     }
 
+    /**
+     * Get a Stream of repository branches from a project, sorted by name alphabetically.
+     *
+     * GET /projects/:id/repository/branches
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @return a Stream of repository branches for the specified project
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<Branch> getBranchesStream(Object projectIdOrPath) throws GitLabApiException {
+        return (getBranches(projectIdOrPath, getDefaultPerPage()).stream());
+    }
+
     /**
      * Get a single project repository branch.
      *
@@ -192,6 +204,7 @@ public Branch unprotectBranch(Object projectIdOrPath, String branchName) throws
      * @throws GitLabApiException if any exception occurs
      * @deprecated Replaced by TagsApi.getTags(Object)
      */
+    @Deprecated
     public List<Tag> getTags(Object projectIdOrPath) throws GitLabApiException {
         Response response = get(Response.Status.OK, getDefaultPerPageParam(), "projects",
                 getProjectIdOrPath(projectIdOrPath), "repository", "tags");
@@ -210,6 +223,7 @@ public List<Tag> getTags(Object projectIdOrPath) throws GitLabApiException {
      * @throws GitLabApiException if any exception occurs
      * @deprecated Replaced by TagsApi.getTags(Object, int, int)
      */
+    @Deprecated
     public List<Tag> getTags(Object projectIdOrPath, int page, int perPage) throws GitLabApiException {
         Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "projects",
                 getProjectIdOrPath(projectIdOrPath), "repository", "tags");
@@ -227,6 +241,7 @@ public List<Tag> getTags(Object projectIdOrPath, int page, int perPage) throws G
      * @throws GitLabApiException if any exception occurs
      * @deprecated Replaced by TagsApi.getTags(Object, int)
      */
+    @Deprecated
     public Pager<Tag> getTags(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException {
         return (new Pager<Tag>(this, Tag.class, itemsPerPage, null, "projects",
                 getProjectIdOrPath(projectIdOrPath), "repository", "tags"));
@@ -332,6 +347,19 @@ public Pager<TreeItem> getTree(Object projectIdOrPath, int itemsPerPage) throws
         return (getTree(projectIdOrPath, "/", "master", false, itemsPerPage));
     }
 
+    /**
+     * Get a list of repository files and directories in a project.
+     *
+     * GET /projects/:id/repository/tree
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @return a Stream containing a tree with the root directories and files of a project
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<TreeItem> getTreeStream(Object projectIdOrPath) throws GitLabApiException {
+        return (getTreeStream(projectIdOrPath, "/", "master"));
+    }
+
     /**
      * Get a list of repository files and directories in a project.
      *
@@ -371,6 +399,25 @@ public Pager<TreeItem> getTree(Object projectIdOrPath, String filePath, String r
         return (getTree(projectIdOrPath, filePath, refName, false, itemsPerPage));
     }
 
+    /**
+     * Get a Stream of repository files and directories in a project.
+     *
+     * GET /projects/:id/repository/tree
+     *
+     * id (required) - The ID of a project
+     * path (optional) - The path inside repository. Used to get content of subdirectories
+     * ref_name (optional) - The name of a repository branch or tag or if not given the default branch
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param filePath the path inside repository, used to get content of subdirectories
+     * @param refName the name of a repository branch or tag or if not given the default branch
+     * @return a Stream containing a tree with the directories and files of a project
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<TreeItem> getTreeStream(Object projectIdOrPath, String filePath, String refName) throws GitLabApiException {
+        return (getTreeStream(projectIdOrPath, filePath, refName, false));
+    }
+
     /**
      * Get a list of repository files and directories in a project.
      *
@@ -389,14 +436,7 @@ public Pager<TreeItem> getTree(Object projectIdOrPath, String filePath, String r
      * @throws GitLabApiException if any exception occurs
      */
     public List<TreeItem> getTree(Object projectIdOrPath, String filePath, String refName, Boolean recursive) throws GitLabApiException {
-        Form formData = new GitLabApiForm()
-                .withParam("id", getProjectIdOrPath(projectIdOrPath), true)
-                .withParam("path", filePath, false)
-                .withParam(isApiVersion(ApiVersion.V3) ? "ref_name" : "ref", refName, false)
-                .withParam("recursive", recursive, false)
-                .withParam(PER_PAGE_PARAM, getDefaultPerPage());
-        Response response = get(Response.Status.OK, formData.asMap(), "projects", getProjectIdOrPath(projectIdOrPath), "repository", "tree");
-        return (response.readEntity(new GenericType<List<TreeItem>>() {}));
+        return (getTree(projectIdOrPath, filePath, refName, recursive, getDefaultPerPage()).all());
     }
 
     /**
@@ -427,6 +467,27 @@ public Pager<TreeItem> getTree(Object projectIdOrPath, String filePath, String r
                 getProjectIdOrPath(projectIdOrPath), "repository", "tree"));
     }
 
+    /**
+     * Get a Stream of repository files and directories in a project.
+     *
+     * GET /projects/:id/repository/tree
+     *
+     * 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
+     * recursive (optional) - Boolean value used to get a recursive tree (false by default)
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @param filePath the path inside repository, used to get content of subdirectories
+     * @param refName the name of a repository branch or tag or if not given the default branch
+     * @param recursive flag to get a recursive tree or not
+     * @return a Stream containing a tree with the directories and files of a project
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<TreeItem> getTreeStream(Object projectIdOrPath, String filePath, String refName, Boolean recursive) throws GitLabApiException {
+        return (getTree(projectIdOrPath, filePath, refName, recursive, getDefaultPerPage()).stream());
+    }
+
     /**
      * Get the raw file contents for a blob by blob SHA.
      *
@@ -634,7 +695,7 @@ public CompareResults compare(Object projectIdOrPath, String from, String to) th
      * @throws GitLabApiException if any exception occurs
      */
     public List<Contributor> getContributors(Object projectIdOrPath) throws GitLabApiException {
-        return (getContributors(projectIdOrPath, 1, getDefaultPerPage()));
+        return (getContributors(projectIdOrPath, getDefaultPerPage()).all());
     }
 
     /**
@@ -668,4 +729,17 @@ public Pager<Contributor> getContributors(Object projectIdOrPath, int itemsPerPa
         return new Pager<Contributor>(this, Contributor.class, itemsPerPage, null, "projects",
                 getProjectIdOrPath(projectIdOrPath), "repository", "contributors");
     }
+
+    /**
+     * Get a list of contributors from a project.
+     *
+     * GET /projects/:id/repository/contributors
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @return a List containing the contributors for the specified project ID
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<Contributor> getContributorsStream(Object projectIdOrPath) throws GitLabApiException {
+        return (getContributors(projectIdOrPath, getDefaultPerPage()).stream());
+    }
 }

src/main/java/org/gitlab4j/api/NotesApi.java

@@ -4,6 +4,7 @@
 import java.io.IOException;
 import java.util.List;
 import java.util.Optional;
+import java.util.stream.Stream;
 
 import javax.ws.rs.core.Form;
 import javax.ws.rs.core.GenericType;
@@ -28,22 +29,20 @@ public TagsApi(GitLabApi gitLabApi) {
     /**
      * Get a list of repository tags from a project, sorted by name in reverse alphabetical order.
      *
-     * GET /projects/:id/repository/tags
+     * <pre><code>GitLab Endpoint: GET /projects/:id/repository/tags</code></pre>
      *
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @return the list of tags for the specified project ID
      * @throws GitLabApiException if any exception occurs
      */
     public List<Tag> getTags(Object projectIdOrPath) throws GitLabApiException {
-        Response response = get(Response.Status.OK, getDefaultPerPageParam(),
-                "projects", getProjectIdOrPath(projectIdOrPath), "repository", "tags");
-        return (response.readEntity(new GenericType<List<Tag>>() { }));
+        return (getTags(projectIdOrPath, getDefaultPerPage()).all());
     }
 
     /**
      * Get a list of repository tags from a project, sorted by name in reverse alphabetical order and in the specified page range.
      *
-     * GET /projects/:id/repository/tags
+     * <pre><code>GitLab Endpoint: GET /projects/:id/repository/tags</code></pre>
      *
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param page the page to get
@@ -60,7 +59,7 @@ public List<Tag> getTags(Object projectIdOrPath, int page, int perPage) throws G
     /**
      * Get a list of repository tags from a project, sorted by name in reverse alphabetical order.
      *
-     * GET /projects/:id/repository/tags
+     * <pre><code>GitLab Endpoint: GET /projects/:id/repository/tags</code></pre>
      *
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param itemsPerPage the number of Project instances that will be fetched per page
@@ -71,10 +70,23 @@ public Pager<Tag> getTags(Object projectIdOrPath, int itemsPerPage) throws GitLa
         return (new Pager<Tag>(this, Tag.class, itemsPerPage, null, "projects", getProjectIdOrPath(projectIdOrPath), "repository", "tags"));
     }
 
+    /**
+     * Get a Stream of repository tags from a project, sorted by name in reverse alphabetical order.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/repository/tags</code></pre>
+     *
+     * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
+     * @return a Stream of tags for the specified project ID
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<Tag> getTagsStream(Object projectIdOrPath) throws GitLabApiException {
+        return (getTags(projectIdOrPath, getDefaultPerPage()).stream());
+    }
+
     /**
      * Get a specific repository tag determined by its name.
      *
-     * GET /projects/:id/repository/tags/:tagName
+     * <pre><code>GitLab Endpoint: GET /projects/:id/repository/tags/:tagName</code></pre>
      *
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param tagName the name of the tag to fetch the info for
@@ -89,7 +101,7 @@ public Tag getTag(Object projectIdOrPath, String tagName) throws GitLabApiExcept
     /**
      * Get an Optional instance holding a Tag instance of a specific repository tag determined by its name.
      *
-     * GET /projects/:id/repository/tags/:tagName
+     * <pre><code>GitLab Endpoint: GET /projects/:id/repository/tags/:tagName</code></pre>
      *
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param tagName the name of the tag to fetch the info for
@@ -107,7 +119,7 @@ public Optional<Tag> getOptionalTag(Object projectIdOrPath, String tagName) thro
     /**
      * Creates a tag on a particular ref of the given project. A message and release notes are optional.
      *
-     * POST /projects/:id/repository/tags
+     * <pre><code>GitLab Endpoint: POST /projects/:id/repository/tags</code></pre>
      *
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param tagName The name of the tag Must be unique for the project
@@ -134,7 +146,7 @@ public Tag createTag(Object projectIdOrPath, String tagName, String ref, String
      * release notes are optional. This method is the same as {@link #createTag(Object, String, String, String, String)},
      * but instead allows the release notes to be supplied in a file.
      *
-     * POST /projects/:id/repository/tags
+     * <pre><code>GitLab Endpoint: POST /projects/:id/repository/tags</code></pre>
      *
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param tagName the name of the tag, must be unique for the project
@@ -163,7 +175,7 @@ public Tag createTag(Object projectIdOrPath, String tagName, String ref, String
     /**
      * Deletes the tag from a project with the specified tag name.
      *
-     * DELETE /projects/:id/repository/tags/:tag_name
+     * <pre><code>GitLab Endpoint: DELETE /projects/:id/repository/tags/:tag_name</code></pre>
      *
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param tagName The name of the tag to delete
@@ -177,7 +189,7 @@ public void deleteTag(Object projectIdOrPath, String tagName) throws GitLabApiEx
     /**
      * Add release notes to the existing git tag.
      *
-     * POST /projects/:id/repository/tags/:tagName/release
+     * <pre><code>GitLab Endpoint: POST /projects/:id/repository/tags/:tagName/release</code></pre>
      *
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param tagName the name of a tag
@@ -195,7 +207,7 @@ public Release createRelease(Object projectIdOrPath, String tagName, String rele
     /**
      * Updates the release notes of a given release.
      *
-     * PUT /projects/:id/repository/tags/:tagName/release
+     * <pre><code>GitLab Endpoint: PUT /projects/:id/repository/tags/:tagName/release</code></pre>
      *
      * @param projectIdOrPath id, path of the project, or a Project instance holding the project ID or path
      * @param tagName the name of a tag