Package software.amazon.awssdk.event

Class ProgressTracker

java.lang.Object

software.amazon.awssdk.event.SyncProgressListener

software.amazon.awssdk.event.ProgressTracker

All Implemented Interfaces:

DeliveryMode, ProgressListener

public class ProgressTracker
extends SyncProgressListener

Default implementation for progress tracking.

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awssdk.event.DeliveryMode

DeliveryMode.Check

Nested classes/interfaces inherited from interface software.amazon.awssdk.event.ProgressListener

ProgressListener.ExceptionReporter, ProgressListener.NoOpProgressListener

Field Summary

Fields

Modifier and Type	Field	Description
static ProgressTracker	NOOP

Constructor Summary

Constructors

Constructor	Description
ProgressTracker()

Method Summary

Modifier and Type	Method	Description
Progress	getProgress()
void	progressChanged(ProgressEvent progressEvent)	Called when progress has changed, such as additional bytes transferred, transfer failed, etc.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class software.amazon.awssdk.event.SyncProgressListener

isSyncCallSafe

Field Detail

NOOP

public static final ProgressTracker NOOP

Constructor Detail

ProgressTracker

public ProgressTracker()

Method Detail

progressChanged

public void progressChanged(ProgressEvent progressEvent)

Description copied from interface: ProgressListener

Called when progress has changed, such as additional bytes transferred, transfer failed, etc. The execution of the callback of this listener is managed by SdkProgressPublisher. Implementation of this interface should never block.

If the implementation follows the best practice and doesn't block, it should then extends from SyncProgressListener.

Note any exception thrown by the listener will get ignored. Should there be need to capture any such exception, you may consider wrapping the listener with ProgressListener.ExceptionReporter.wrap(ProgressListener).

Parameters:

progressEvent - The event describing the progress change.

See Also:

SdkProgressPublisher, ProgressListener.ExceptionReporter

getProgress

public Progress getProgress()