software.amazon.awssdk.transfer.s3.internal.progress

Class DefaultTransferProgress

java.lang.Object

software.amazon.awssdk.transfer.s3.internal.progress.DefaultTransferProgress

All Implemented Interfaces:

TransferProgress

@Mutable
 @ThreadSafe
public final class DefaultTransferProgress
extends Object
implements TransferProgress

An SDK-internal implementation of TransferProgress. This implementation acts as a thin wrapper around AtomicReference, where calls to get the latest snapshot() simply return the latest reference, while TransferProgressUpdater is responsible for continuously updating the latest reference.

See Also:

TransferProgress

Constructor Summary

Constructors

Constructor and Description
DefaultTransferProgress(TransferProgressSnapshot snapshot)

Method Summary

Modifier and Type	Method and Description
TransferProgressSnapshot	snapshot() Take a snapshot of the current progress, represented by an immutable TransferProgressSnapshot.
String	toString()
TransferProgressSnapshot	updateAndGet(Consumer<DefaultTransferProgressSnapshot.Builder> updater) Atomically convert the current snapshot reference to its DefaultTransferProgressSnapshot.Builder, perform updates using the provided Consumer, and save the result as the latest snapshot.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultTransferProgress

public DefaultTransferProgress(TransferProgressSnapshot snapshot)

Method Detail

updateAndGet

public TransferProgressSnapshot updateAndGet(Consumer<DefaultTransferProgressSnapshot.Builder> updater)

Atomically convert the current snapshot reference to its DefaultTransferProgressSnapshot.Builder, perform updates using the provided Consumer, and save the result as the latest snapshot.

snapshot

public TransferProgressSnapshot snapshot()

Description copied from interface: TransferProgress

Take a snapshot of the current progress, represented by an immutable TransferProgressSnapshot.

Specified by:

snapshot in interface TransferProgress

toString

public String toString()

Overrides:

toString in class Object