software.amazon.awssdk.transfer.s3.model.CompletedDirectoryDownload Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of s3-transfer-manager Show documentation
The S3 Transfer Manager allows customers to easily and optimally transfer objects and directories to and from S3.
There is a newer version: 2.28.4
/*
 * 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.model;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.transfer.s3.S3TransferManager;
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
public final class CompletedDirectoryDownload implements CompletedDirectoryTransfer,
                                                         ToCopyableBuilder {

    private final List failedTransfers;

    private CompletedDirectoryDownload(DefaultBuilder builder) {
        this.failedTransfers = Collections.unmodifiableList(
            new ArrayList<>(Validate.paramNotNull(builder.failedTransfers, "failedTransfers")));
    }

    @Override
    public List 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 serializableBuilderClass() {
        return DefaultBuilder.class;
    }

    @Override
    public Builder toBuilder() {
        return new DefaultBuilder(this);
    }

    public interface Builder extends CopyableBuilder  {

        /**
         * Sets a collection of {@link FailedFileDownload}s
         *
         * @param failedTransfers failed download
         * @return This builder for method chaining.
         */
        Builder failedTransfers(Collection failedTransfers);

        /**
         * Adds 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 failedTransfers = new ArrayList<>();

        private DefaultBuilder() {
        }

        private DefaultBuilder(CompletedDirectoryDownload completedDirectoryDownload) {
            this.failedTransfers = new ArrayList<>(completedDirectoryDownload.failedTransfers);
        }

        @Override
        public Builder failedTransfers(Collection failedTransfers) {
            this.failedTransfers = new ArrayList<>(failedTransfers);
            return this;
        }

        @Override
        public Builder addFailedTransfer(FailedFileDownload failedTransfer) {
            failedTransfers.add(failedTransfer);
            return this;
        }

        public Collection getFailedTransfers() {
            return Collections.unmodifiableCollection(failedTransfers);
        }

        public void setFailedTransfers(Collection failedTransfers) {
            failedTransfers(failedTransfers);
        }

        @Override
        public CompletedDirectoryDownload build() {
            return new CompletedDirectoryDownload(this);
        }
    }
}