[TM DownloadDirectory Part1] Create POJO classes for download directory

services-custom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/CompletedDirectoryDownload.java

@@ -0,0 +1,156 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.transfer.s3;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Objects;
+import software.amazon.awssdk.annotations.SdkPreviewApi;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.utils.ToString;
+import software.amazon.awssdk.utils.Validate;
+import software.amazon.awssdk.utils.builder.CopyableBuilder;
+import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
+
+/**
+ * Represents a completed download directory transfer to Amazon S3. It can be used to track
+ * failed single file downloads.
+ *
+ * @see S3TransferManager#downloadDirectory(DownloadDirectoryRequest) 
+ */
+@SdkPublicApi
+@SdkPreviewApi
+public final class CompletedDirectoryDownload implements CompletedDirectoryTransfer,
+                                                         ToCopyableBuilder<CompletedDirectoryDownload.Builder,
+                                                             CompletedDirectoryDownload> {
+
+    private final Collection<FailedFileDownload> failedTransfers;
+
+    private CompletedDirectoryDownload(DefaultBuilder builder) {
+        this.failedTransfers = Collections.unmodifiableCollection(
+            new ArrayList<>(Validate.paramNotNull(builder.failedTransfers, "failedTransfers")));
+    }
+
+    @Override
+    public Collection<FailedFileDownload> failedTransfers() {
+        return failedTransfers;
+    }
+
+    /**
+     * Creates a default builder for {@link CompletedDirectoryDownload}.
+     */
+    public static Builder builder() {
+        return new DefaultBuilder();
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+
+        CompletedDirectoryDownload that = (CompletedDirectoryDownload) o;
+
+        return Objects.equals(failedTransfers, that.failedTransfers);
+    }
+
+    @Override
+    public int hashCode() {
+        return failedTransfers != null ? failedTransfers.hashCode() : 0;
+    }
+
+    @Override
+    public String toString() {
+        return ToString.builder("CompletedDirectoryDownload")
+                       .add("failedTransfers", failedTransfers)
+                       .build();
+    }
+
+    public static Class<? extends Builder> serializableBuilderClass() {
+        return DefaultBuilder.class;
+    }
+
+    @Override
+    public Builder toBuilder() {
+        return new DefaultBuilder(this);
+    }
+
+    public interface Builder extends CopyableBuilder<CompletedDirectoryDownload.Builder,
+        CompletedDirectoryDownload>  {
+
+        /**
+         * Sets a collection of {@link FailedFileDownload}s
+         *
+         * @param failedTransfers failed download
+         * @return This builder for method chaining.
+         */
+        Builder failedTransfers(Collection<FailedFileDownload> failedTransfers);
+
+        /**
+         * Add a {@link FailedFileDownload}
+         *
+         * @param failedTransfer failed download
+         * @return This builder for method chaining.
+         */
+        Builder addFailedTransfer(FailedFileDownload failedTransfer);
+
+        /**
+         * Builds a {@link CompletedDirectoryDownload} based on the properties supplied to this builder
+         * @return An initialized {@link CompletedDirectoryDownload}
+         */
+        CompletedDirectoryDownload build();
+    }
+
+    private static final class DefaultBuilder implements Builder {
+        private Collection<FailedFileDownload> failedTransfers = new ArrayList<>();
+
+        private DefaultBuilder() {
+        }
+
+        private DefaultBuilder(CompletedDirectoryDownload completedDirectoryDownload) {
+            this.failedTransfers = new ArrayList<>(completedDirectoryDownload.failedTransfers);
+        }
+
+        @Override
+        public Builder failedTransfers(Collection<FailedFileDownload> failedTransfers) {
+            this.failedTransfers = new ArrayList<>(failedTransfers);
+            return this;
+        }
+
+        @Override
+        public Builder addFailedTransfer(FailedFileDownload failedTransfer) {
+            failedTransfers.add(failedTransfer);
+            return this;
+        }
+
+        public Collection<FailedFileDownload> getFailedTransfers() {
+            return Collections.unmodifiableCollection(failedTransfers);
+        }
+
+        public void setFailedTransfers(Collection<FailedFileDownload> failedTransfers) {
+            failedTransfers(failedTransfers);
+        }
+
+        @Override
+        public CompletedDirectoryDownload build() {
+            return new CompletedDirectoryDownload(this);
+        }
+    }
+}

services-custom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/CompletedDirectoryUpload.java

@@ -23,6 +23,8 @@
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.utils.ToString;
 import software.amazon.awssdk.utils.Validate;
+import software.amazon.awssdk.utils.builder.CopyableBuilder;
+import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
 
 /**
  * Represents a completed upload directory transfer to Amazon S3. It can be used to track
@@ -32,13 +34,15 @@
  */
 @SdkPublicApi
 @SdkPreviewApi
-public final class CompletedDirectoryUpload implements CompletedDirectoryTransfer {
+public final class CompletedDirectoryUpload implements CompletedDirectoryTransfer,
+                                                       ToCopyableBuilder<CompletedDirectoryUpload.Builder,
+                                                           CompletedDirectoryUpload> {
 
     private final Collection<FailedFileUpload> failedTransfers;
 
     private CompletedDirectoryUpload(DefaultBuilder builder) {
         this.failedTransfers = Collections.unmodifiableCollection(
-            Validate.paramNotNull(builder.failedTransfers, "failedTransfers"));
+            new ArrayList<>(Validate.paramNotNull(builder.failedTransfers, "failedTransfers")));
     }
 
     @Override
@@ -83,7 +87,13 @@ public static Class<? extends Builder> serializableBuilderClass() {
         return DefaultBuilder.class;
     }
 
-    public interface Builder {
+    @Override
+    public Builder toBuilder() {
+        return new DefaultBuilder(this);
+    }
+
+    public interface Builder extends CopyableBuilder<CompletedDirectoryUpload.Builder,
+        CompletedDirectoryUpload> {
 
         /**
          * Sets a collection of {@link FailedFileUpload}s
@@ -109,11 +119,15 @@ public interface Builder {
     }
 
     private static final class DefaultBuilder implements Builder {
-        private Collection<FailedFileUpload> failedTransfers;
+        private Collection<FailedFileUpload> failedTransfers = new ArrayList<>();
 
         private DefaultBuilder() {
         }
 
+        private DefaultBuilder(CompletedDirectoryUpload completedDirectoryUpload) {
+            this.failedTransfers = new ArrayList<>(completedDirectoryUpload.failedTransfers);
+        }
+
         @Override
         public Builder failedTransfers(Collection<FailedFileUpload> failedTransfers) {
             this.failedTransfers = new ArrayList<>(failedTransfers);
@@ -122,9 +136,6 @@ public Builder failedTransfers(Collection<FailedFileUpload> failedTransfers) {
 
         @Override
         public Builder addFailedTransfer(FailedFileUpload failedTransfer) {
-            if (failedTransfers == null) {
-                failedTransfers = new ArrayList<>();
-            }
             failedTransfers.add(failedTransfer);
             return this;
         }

services-custom/s3-transfer-manager/src/main/java/software/amazon/awssdk/transfer/s3/DirectoryDownload.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.transfer.s3;
+
+import java.util.concurrent.CompletableFuture;
+import software.amazon.awssdk.annotations.SdkPreviewApi;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+
+/**
+ * A download transfer of a directory of objects from S3
+ */
+@SdkPublicApi
+@SdkPreviewApi
+public interface DirectoryDownload extends DirectoryTransfer {
+    @Override
+    CompletableFuture<CompletedDirectoryDownload> completionFuture();
+}