[doc] clarify lazy-eval of removeObjects (#811)

minio · Nov 13, 2019 · 79f2eab · 79f2eab
1 parent 4a7779b
commit 79f2eab
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/api/src/main/java/io/minio/MinioClient.java b/api/src/main/java/io/minio/MinioClient.java
@@ -2985,7 +2985,8 @@ private List<DeleteError> removeObject(String bucketName, List<DeleteObject> obj
 
 
   /**
-   * Removes multiple objects from a bucket.
+   * Removes multiple objects from a bucket. As objects removal are lazily executed, its required
+   * to iterate the returned Iterable.
    *
    * </p><b>Example:</b><br>
    * <pre>{@code // Create object list for removal.
@@ -3000,6 +3001,8 @@ private List<DeleteError> removeObject(String bucketName, List<DeleteObject> obj
    *
    * @param bucketName Bucket name.
    * @param objectNames List of Object names in the bucket.
+   *
+   * @return (lazy) Iterable of the Result DeleteErrors.
    */
   public Iterable<Result<DeleteError>> removeObjects(final String bucketName, final Iterable<String> objectNames) {
     return new Iterable<Result<DeleteError>>() {

diff --git a/examples/RemoveObjects.java b/examples/RemoveObjects.java
@@ -48,6 +48,7 @@ public static void main(String[] args)
       objectNames.add("my-objectname3");
 
       // Remove object all objects 'objectNames' list from 'my-bucketname'.
+      // It is required to traverse over the returned Iterable for lazy evaluation.
       for (Result<DeleteError> errorResult: minioClient.removeObjects("my-bucketname", objectNames)) {
         DeleteError error = errorResult.get();
         System.out.println("Failed to remove '" + error.objectName() + "'. Error:" + error.message());