Added getXxxxxStream() methods that return Java 8 Streams.

Author: gmessner

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

@@ -2,6 +2,7 @@
 
 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;
@@ -20,22 +21,21 @@ public DeployKeysApi(GitLabApi gitLabApi) {
 
     /**
      * Get a list of all deploy keys across all projects of the GitLab instance. This method requires admin access.
-     * Only returns the first page.
      *
-     * GET /deploy_keys
+     * <pre><code>GitLab Endpoint: GET /deploy_keys</code></pre>
      *
      * @return a list of DeployKey
      * @throws GitLabApiException if any exception occurs
      */
     public List<DeployKey> getDeployKeys() throws GitLabApiException {
-        return (getDeployKeys(1, getDefaultPerPage()));
+        return (getDeployKeys(getDefaultPerPage()).all());
     }
 
     /**
      * Get a list of all deploy keys across all projects of the GitLab instance using the specified page and per page settings. 
      * This method requires admin access.
      *
-     * GET /deploy_keys
+     * <pre><code>GitLab Endpoint: GET /deploy_keys</code></pre>
      *
      * @param page the page to get
      * @param perPage the number of deploy keys per page
@@ -50,7 +50,7 @@ public List<DeployKey> getDeployKeys(int page, int perPage) throws GitLabApiExce
     /**
      * Get a Pager of all deploy keys across all projects of the GitLab instance. This method requires admin access.
      *
-     * GET /deploy_keys
+     * <pre><code>GitLab Endpoint: GET /deploy_keys</code></pre>
      *
      * @param itemsPerPage the number of DeployKey instances that will be fetched per page
      * @return a Pager of DeployKey
@@ -59,98 +59,111 @@ public List<DeployKey> getDeployKeys(int page, int perPage) throws GitLabApiExce
     public Pager<DeployKey> getDeployKeys(int itemsPerPage) throws GitLabApiException {
         return (new Pager<DeployKey>(this, DeployKey.class, itemsPerPage, null, "deploy_keys"));
     }
-    
+
+    /**
+     * Get a Stream of all deploy keys across all projects of the GitLab instance. This method requires admin access.
+     *
+     * <pre><code>GitLab Endpoint: GET /deploy_keys</code></pre>
+     *
+     * @return a list of DeployKey
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<DeployKey> getDeployKeysStream() throws GitLabApiException {
+        return (getDeployKeys(getDefaultPerPage()).stream());
+    }
+
     /**
      * Get a list of the deploy keys for the specified project. This method requires admin access.
-     * Only returns the first page.
      *
-     * GET /projects/:id/deploy_keys
+     * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys</code></pre>
      *
-     * @param projectId the ID of the project
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
      * @return a list of DeployKey
      * @throws GitLabApiException if any exception occurs
      */
-    public List<DeployKey> getProjectDeployKeys(Integer projectId) throws GitLabApiException {
-        return (getProjectDeployKeys(projectId, 1, getDefaultPerPage()));
+    public List<DeployKey> getProjectDeployKeys(Object projectIdOrPath) throws GitLabApiException {
+        return (getProjectDeployKeys(projectIdOrPath, getDefaultPerPage()).all());
     }
 
     /**
      * Get a list of the deploy keys for the specified project using the specified page and per page settings. 
      * This method requires admin access.
      *
-     * GET /projects/:id/deploy_keys
+     * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys</code></pre>
      *
-     * @param projectId the ID of the project
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
      * @param page the page to get
      * @param perPage the number of deploy keys per page
      * @return the list of DeployKey in the specified range
      * @throws GitLabApiException if any exception occurs
      */
-    public List<DeployKey> getProjectDeployKeys(Integer projectId, int page, int perPage) throws GitLabApiException {
-
-        if (projectId == null) {
-            throw new RuntimeException("projectId cannot be null");
-        }
-
-        Response response = get(Response.Status.OK, getPageQueryParams(page, perPage), "projects", projectId, "deploy_keys");
+    public List<DeployKey> getProjectDeployKeys(Object projectIdOrPath, int page, int perPage) throws GitLabApiException {
+        Response response = get(Response.Status.OK, getPageQueryParams(page, perPage),
+                "projects", getProjectIdOrPath(projectIdOrPath), "deploy_keys");
         return (response.readEntity(new GenericType<List<DeployKey>>() {}));
     }
 
     /**
      * Get a Pager of the deploy keys for the specified project. This method requires admin access.
      *
-     * GET /projects/:id/deploy_keys
+     * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys</code></pre>
      *
-     * @param projectId the ID of the project
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance@param projectId the ID of the project
      * @param itemsPerPage the number of DeployKey instances that will be fetched per page
      * @return a Pager of DeployKey
      * @throws GitLabApiException if any exception occurs
      */
-    public Pager<DeployKey> getProjectDeployKeys(Integer projectId, Integer itemsPerPage) throws GitLabApiException {
-
-        if (projectId == null) {
-            throw new RuntimeException("projectId cannot be null");
-        }
+    public Pager<DeployKey> getProjectDeployKeys(Object projectIdOrPath, int itemsPerPage) throws GitLabApiException {
+        return (new Pager<DeployKey>(this, DeployKey.class, itemsPerPage, null,
+                "projects", getProjectIdOrPath(projectIdOrPath), "deploy_keys"));
+    }
 
-        return (new Pager<DeployKey>(this, DeployKey.class, itemsPerPage, null, "projects", projectId, "deploy_keys"));
+    /**
+     * Get a list of the deploy keys for the specified project. This method requires admin access.
+     *
+     * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys</code></pre>
+     *
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
+     * @return a list of DeployKey
+     * @throws GitLabApiException if any exception occurs
+     */
+    public Stream<DeployKey> getProjectDeployKeysStream(Object projectIdOrPath) throws GitLabApiException {
+        return (getProjectDeployKeys(projectIdOrPath, getDefaultPerPage()).stream());
     }
 
     /**
      * Get a single deploy key for the specified project.
      *
-     * GET /projects/:id/deploy_keys/:key_id
+     * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys/:key_id</code></pre>
      *
-     * @param projectId the ID of the project
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
      * @param keyId the ID of the deploy key to delete
      * @return the DeployKey instance for the specified project ID and key ID
      * @throws GitLabApiException if any exception occurs
      */
-    public DeployKey getDeployKey(Integer projectId, Integer keyId) throws GitLabApiException {
-
-        if (projectId == null) {
-            throw new RuntimeException("projectId cannot be null");
-        }
+    public DeployKey getDeployKey(Object projectIdOrPath, Integer keyId) throws GitLabApiException {
 
         if (keyId == null) {
             throw new RuntimeException("keyId cannot be null");
         }
 
-        Response response = get(Response.Status.OK, null, "projects", projectId, "deploy_keys", keyId);
+        Response response = get(Response.Status.OK, null,
+                "projects", getProjectIdOrPath(projectIdOrPath), "deploy_keys", keyId);
         return (response.readEntity(DeployKey.class));
     }
 
     /**
      * Get a single deploy key for the specified project as an Optional instance.
      *
-     * GET /projects/:id/deploy_keys/:key_id
+     * <pre><code>GitLab Endpoint: GET /projects/:id/deploy_keys/:key_id</code></pre>
      *
-     * @param projectId the ID of the project
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
      * @param keyId the ID of the deploy key to delete
      * @return the DeployKey for the specified project ID and key ID as an Optional instance
      */
-    public Optional<DeployKey> getOptionalDeployKey(Integer projectId, Integer keyId) {
+    public Optional<DeployKey> getOptionalDeployKey(Object projectIdOrPath, Integer keyId) {
         try {
-            return (Optional.ofNullable(getDeployKey(projectId, keyId)));
+            return (Optional.ofNullable(getDeployKey(projectIdOrPath, keyId)));
         } catch (GitLabApiException glae) {
             return (GitLabApi.createOptionalFromException(glae));
         }
@@ -159,72 +172,62 @@ public Optional<DeployKey> getOptionalDeployKey(Integer projectId, Integer keyId
     /**
      * Creates a new deploy key for a project.
      *
-     * POST /projects/:id/deploy_keys
+     * <pre><code>GitLab Endpoint: POST /projects/:id/deploy_keys</code></pre>
      *
-     * @param projectId the ID of the project owned by the authenticated user, required
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
      * @param title the new deploy key's title, required
      * @param key the new deploy key, required
      * @param canPush can deploy key push to the project's repository, optional
      * @return an DeployKey instance with info on the added deploy key
      * @throws GitLabApiException if any exception occurs
      */
-    public DeployKey addDeployKey(Integer projectId, String title, String key, Boolean canPush) throws GitLabApiException {
-
-        if (projectId == null) {
-            throw new RuntimeException("projectId cannot be null");
-        }
+    public DeployKey addDeployKey(Object projectIdOrPath, String title, String key, Boolean canPush) throws GitLabApiException {
 
         GitLabApiForm formData = new GitLabApiForm()
                 .withParam("title", title, true)
                 .withParam("key", key, true)
                 .withParam("can_push",  canPush);
-        Response response = post(Response.Status.CREATED, formData, "projects", projectId, "deploy_keys");
+        Response response = post(Response.Status.CREATED, formData,
+                "projects", getProjectIdOrPath(projectIdOrPath), "deploy_keys");
         return (response.readEntity(DeployKey.class));
     }
 
     /**
      * Removes a deploy key from the project. If the deploy key is used only for this project,it will be deleted from the system.
      *
-     * DELETE /projects/:id/deploy_keys/:key_id
+     * <pre><code>GitLab Endpoint: DELETE /projects/:id/deploy_keys/:key_id</code></pre>
      *
-     * @param projectId the ID of the project
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
      * @param keyId the ID of the deploy key to delete
      * @throws GitLabApiException if any exception occurs
      */
-    public void deleteDeployKey(Integer projectId, Integer keyId) throws GitLabApiException {
-
-        if (projectId == null) {
-            throw new RuntimeException("projectId cannot be null");
-        }
+    public void deleteDeployKey(Object projectIdOrPath, Integer keyId) throws GitLabApiException {
 
         if (keyId == null) {
             throw new RuntimeException("keyId cannot be null");
         }
 
-        delete(Response.Status.OK, null, "projects", projectId, "deploy_keys", keyId);
+        delete(Response.Status.OK, null, "projects", getProjectIdOrPath(projectIdOrPath), "deploy_keys", keyId);
     }
 
     /**
      * Enables a deploy key for a project so this can be used. Returns the enabled key when successful.
      *
-     * POST /projects/:id/deploy_keys/:key_id/enable
+     * <pre><code>GitLab Endpoint: POST /projects/:id/deploy_keys/:key_id/enable</code></pre>
      *
-     * @param projectId the ID of the project
+     * @param projectIdOrPath the project in the form of an Integer(ID), String(path), or Project instance
      * @param keyId the ID of the deploy key to enable
      * @return an DeployKey instance with info on the enabled deploy key
      * @throws GitLabApiException if any exception occurs
      */
-    public DeployKey enableDeployKey(Integer projectId, Integer keyId) throws GitLabApiException {
-
-        if (projectId == null) {
-            throw new RuntimeException("projectId cannot be null");
-        }
+    public DeployKey enableDeployKey(Object projectIdOrPath, Integer keyId) throws GitLabApiException {
 
         if (keyId == null) {
             throw new RuntimeException("keyId cannot be null");
         }
 
-        Response response = post(Response.Status.CREATED, (Form)null, "projects", projectId, "deploy_keys", keyId, "enable");
+        Response response = post(Response.Status.CREATED, (Form)null,
+                "projects", getProjectIdOrPath(projectIdOrPath), "deploy_keys", keyId, "enable");
         return (response.readEntity(DeployKey.class));
     }
 }