Package software.amazon.awssdk.event

Class ProgressListener.NoOpProgressListener

java.lang.Object

software.amazon.awssdk.event.ProgressListener.NoOpProgressListener

All Implemented Interfaces:

DeliveryMode, ProgressListener

Enclosing interface:

ProgressListener

public static class ProgressListener.NoOpProgressListener
extends Object
implements ProgressListener, DeliveryMode

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 inherited from interface software.amazon.awssdk.event.ProgressListener

NOOP

Constructor Summary

Constructors

Constructor	Description
NoOpProgressListener()

Method Summary

Modifier and Type	Method	Description
boolean	isSyncCallSafe()	Returns true if it is safe to make a synchronous callback to the implementing listener without the risk of incurring undue latency; false otherwise.
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

Constructor Detail

NoOpProgressListener

public NoOpProgressListener()

Method Detail

isSyncCallSafe

public boolean isSyncCallSafe()

Description copied from interface: DeliveryMode

Returns true if it is safe to make a synchronous callback to the implementing listener without the risk of incurring undue latency; false otherwise.

Specified by:

isSyncCallSafe in interface DeliveryMode

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).

Specified by:

progressChanged in interface ProgressListener

Parameters:

progressEvent - The event describing the progress change.

See Also:

SdkProgressPublisher, ProgressListener.ExceptionReporter