Added getXxxxxStream() methods that return Java 8 Streams.

Author: gmessner

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

@@ -3,6 +3,7 @@
 import java.util.Date;
 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;
@@ -29,15 +30,15 @@ public EpicsApi(GitLabApi gitLabApi) {
 
     /**
      * Gets all epics of the requested group and its subgroups.
-     * 
+     *
      * <pre><code>GitLab Endpoint: GET /groups/:id/epics</code></pre>
      *
      * @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
      * @return a list of all epics of the requested group and its subgroups
      * @throws GitLabApiException if any exception occurs
      */
     public List<Epic> getEpics(Object groupIdOrPath) throws GitLabApiException {
-        return (getEpics(groupIdOrPath, 1, getDefaultPerPage()));
+        return (getEpics(groupIdOrPath, getDefaultPerPage()).all());
     }
 
     /**
@@ -70,6 +71,19 @@ public Pager<Epic> getEpics(Object groupIdOrPath, int itemsPerPage) throws GitLa
         return (new Pager<Epic>(this, Epic.class, itemsPerPage, null, "groups", getGroupIdOrPath(groupIdOrPath), "epics"));
     }
 
+    /**
+     * Gets all epics of the requested group and its subgroups as a Stream.
+     *
+     * <pre><code>GitLab Endpoint: GET /groups/:id/epics</code></pre>
+     *
+     * @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
+     * @return a Stream of all epics of the requested group and its subgroups
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<Epic> getEpicsStream(Object groupIdOrPath) throws GitLabApiException {
+        return (getEpics(groupIdOrPath, getDefaultPerPage()).stream());
+    }
+
     /**
      * Gets all epics of the requested group and its subgroups.
      * 
@@ -87,7 +101,7 @@ public Pager<Epic> getEpics(Object groupIdOrPath, int itemsPerPage) throws GitLa
      */
     public List<Epic> getEpics(Object groupIdOrPath, Integer authorId, String labels, EpicOrderBy orderBy,
             SortOrder sortOrder, String search) throws GitLabApiException {
-        return (getEpics(groupIdOrPath, authorId, labels, orderBy, sortOrder, search, 1, getDefaultPerPage()));
+        return (getEpics(groupIdOrPath, authorId, labels, orderBy, sortOrder, search, getDefaultPerPage()).all());
     }
 
     /**
@@ -146,6 +160,26 @@ public Pager<Epic> getEpics(Object groupIdOrPath, Integer authorId, String label
         return (new Pager<Epic>(this, Epic.class, itemsPerPage, formData.asMap(), "groups", getGroupIdOrPath(groupIdOrPath), "epics"));
     }
 
+    /**
+     * Gets all epics of the requested group and its subgroups as a Stream.
+     *
+     * <pre><code>GitLab Endpoint: GET /groups/:id/epics</code></pre>
+     *
+     * @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
+     * @param authorId returns epics created by the given user id
+     * @param labels return epics matching a comma separated list of labels names.
+     *        Label names from the epic group or a parent group can be used
+     * @param orderBy return epics ordered by CREATED_AT or UPDATED_AT. Default is CREATED_AT
+     * @param sortOrder return epics sorted in ASC or DESC order. Default is DESC
+     * @param search search epics against their title and description
+     * @return a Stream of matching epics of the requested group and its subgroups
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<Epic> getEpicsStream(Object groupIdOrPath, Integer authorId, String labels, EpicOrderBy orderBy,
+            SortOrder sortOrder, String search) throws GitLabApiException {
+        return (getEpics(groupIdOrPath, authorId, labels, orderBy, sortOrder, search, getDefaultPerPage()).stream());
+    }
+
     /**
      * Get a single epic for the specified group.
      *
@@ -305,11 +339,10 @@ public Epic updateEpic(Object groupIdOrPath, Integer epicIid, Epic epic) throws
     public void deleteEpic(Object groupIdOrPath, Integer epicIid) throws GitLabApiException {
         delete(Response.Status.NO_CONTENT, null, "groups", getGroupIdOrPath(groupIdOrPath), "epics", epicIid);
     }
-    
 
     /**
      * Gets all issues that are assigned to an epic and the authenticated user has access to.
-     * 
+     *
      * <pre><code>GitLab Endpoint: GET /groups/:id/epics/:epic_iid/issues</code></pre>
      *
      * @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
@@ -318,13 +351,13 @@ public void deleteEpic(Object groupIdOrPath, Integer epicIid) throws GitLabApiEx
      * @throws GitLabApiException if any exception occurs
      */
     public List<Epic> getEpicIssues(Object groupIdOrPath, Integer epicIid) throws GitLabApiException {
-        return (getEpicIssues(groupIdOrPath, epicIid, 1, getDefaultPerPage()));
+        return (getEpicIssues(groupIdOrPath, epicIid, getDefaultPerPage()).all());
     }
 
     /**
      * Gets all issues that are assigned to an epic and the authenticated user has access to
      * using the specified page and per page setting.
-     * 
+     *
      * <pre><code>GitLab Endpoint: GET /groups/:id/epics/:epic_iid/issues</code></pre>
      *
      * @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
@@ -341,7 +374,7 @@ public List<Epic> getEpicIssues(Object groupIdOrPath, Integer epicIid, int page,
 
     /**
      * Get a Pager of all issues that are assigned to an epic and the authenticated user has access to.
-     * 
+     *
      * <pre><code>GitLab Endpoint: GET /groups/:id/epics/:epic_iid/issues</code></pre>
      *
      * @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
@@ -354,6 +387,20 @@ public Pager<Epic> getEpicIssues(Object groupIdOrPath, Integer epicIid, int item
         return (new Pager<Epic>(this, Epic.class, itemsPerPage, null, "groups", getGroupIdOrPath(groupIdOrPath), "epics", epicIid, "issues"));
     }
 
+    /**
+     * Gets all issues that are assigned to an epic and the authenticated user has access to as a Stream.
+     *
+     * <pre><code>GitLab Endpoint: GET /groups/:id/epics/:epic_iid/issues</code></pre>
+     *
+     * @param groupIdOrPath the group ID, path of the group, or a Group instance holding the group ID or path
+     * @param epicIid the IID of the epic to get issues for
+     * @return a Stream of all epic issues belonging to the specified epic
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<Epic> getEpicIssuesStream(Object groupIdOrPath, Integer epicIid) throws GitLabApiException {
+        return (getEpicIssues(groupIdOrPath, epicIid, getDefaultPerPage()).stream());
+    }
+
     /**
      * Creates an epic - issue association. If the issue in question belongs to another epic
      * it is unassigned from that epic.

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

@@ -17,7 +17,7 @@ public MarkdownApi(GitLabApi gitLabApi) {
     /**
      * Render an arbitrary Markdown document.
      *
-     * POST /api/v4/markdown
+     * <pre><code>GitLab Endpoint: POST /api/v4/markdown</code></pre>
      *
      * @param text text to be transformed
      * @return a Markdown instance with transformed info
@@ -26,7 +26,7 @@ public MarkdownApi(GitLabApi gitLabApi) {
      */
     public Markdown getMarkdown(String text) throws GitLabApiException {
 
-        if(!isApiVersion(ApiVersion.V4)){
+        if (!isApiVersion(ApiVersion.V4)) {
             throw new GitLabApiException("Api version must be v4");
         }