com.amazonaws.event

Class ProgressListenerChain

java.lang.Object

com.amazonaws.event.ProgressListenerChain

All Implemented Interfaces:

ProgressListener

public class ProgressListenerChain
extends java.lang.Object
implements ProgressListener

An implementation of ProgressListener interface that delegates progressChanged callback to multiple listeners. It also takes an optional ProgressEventFilter to filter incoming events before passing them to the listeners.

This class could be used for both Amazon S3 and Amazon Glacier clients. The legacy Amazon S3 progress listener chain com.amazonaws.services.s3.transfer.internal.ProgressListenerChain has been deprecated in favor of this new class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProgressListenerChain.ProgressEventFilter An interface that filters the incoming events before passing them into the registered listeners.

Constructor Summary

Constructors

Constructor and Description
ProgressListenerChain(ProgressListener... listeners) Create a listener chain that directly passes all the progress events to the specified listeners.
ProgressListenerChain(ProgressListenerChain.ProgressEventFilter progressEventFilter, ProgressListener... listeners) Create a listener chain with a ProgressEventFilter.

Method Summary

Modifier and Type	Method and Description
void	addProgressListener(ProgressListener listener) Adds the progress listener.
void	progressChanged(ProgressEvent progressEvent) Called when progress has changed, such as additional bytes transferred, transfer failed, etc.
void	removeProgressListener(ProgressListener listener) Removes the progress listeners.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressListenerChain

public ProgressListenerChain(ProgressListener... listeners)

Create a listener chain that directly passes all the progress events to the specified listeners.

Parameters:

listeners - the progress listener.

ProgressListenerChain

public ProgressListenerChain(ProgressListenerChain.ProgressEventFilter progressEventFilter,
                             ProgressListener... listeners)

Create a listener chain with a ProgressEventFilter.

Parameters:

listeners - the progress listener.

progressEventFilter - the progress event filter.

Method Detail

addProgressListener

public void addProgressListener(ProgressListener listener)

Adds the progress listener.

Parameters:

listener - the progress listener.

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Removes the progress listeners.

Parameters:

listener - the progress listener.

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 ProgressListenerCallbackExecutor class, which maintains a single thread to sequentially execute all progressChanged callbacks.

Specified by:

progressChanged in interface ProgressListener

Parameters:

progressEvent - The event describing the progress change.

See Also:

ProgressListenerCallbackExecutor