Package net.markenwerk.utils.data.fetcher

Class IdleDataFetchProgressListener

java.lang.Object

net.markenwerk.utils.data.fetcher.IdleDataFetchProgressListener

All Implemented Interfaces:

DataFetchProgressListener

public class IdleDataFetchProgressListener
extends Object
implements DataFetchProgressListener

An IdleDataFetchProgressListener is a DataFetchProgressListener with empty methods. It is intended a base implementation for custom DataFetchProgressListener implementations, that don't need to implement all methods.

Since:

4.0.0

Author:

Torsten Krause (tk at markenwerk dot net)

Constructor Summary

Constructors

Constructor	Description
IdleDataFetchProgressListener()

Method Summary

Modifier and Type	Method	Description
void	onFailed(DataFetchException exception, Long bytesFetched)	Indicates that the process of fetching bytes from an InputStream has failed.
void	onFinished()	Indicates that the process of fetching bytes from an InputStream has finished.
void	onProgress(long bytesFetched)	Indicates that the process of fetching bytes from an InputStream has progressed.
void	onStarted()	Indicates that the process of fetching bytes from an InputStream has started.
void	onSuccedded(Long bytesFetched)	Indicates that the process of fetching bytes from an InputStream has succeeded.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdleDataFetchProgressListener

public IdleDataFetchProgressListener()

Method Detail

onStarted

public void onStarted()

Description copied from interface: DataFetchProgressListener

Indicates that the process of fetching bytes from an InputStream has started.

Specified by:

onStarted in interface DataFetchProgressListener

onProgress

public void onProgress(long bytesFetched)

Description copied from interface: DataFetchProgressListener

Indicates that the process of fetching bytes from an InputStream has progressed.

The progress will only be reported if the DataFetcher is capable of monitoring the progress.

Specified by:

onProgress in interface DataFetchProgressListener

Parameters:

bytesFetched - Total amount of bytes fetched so far.

onSuccedded

public void onSuccedded(Long bytesFetched)

Description copied from interface: DataFetchProgressListener

Indicates that the process of fetching bytes from an InputStream has succeeded.

Specified by:

onSuccedded in interface DataFetchProgressListener

Parameters:

bytesFetched - Total total amount of bytes fetched or null, if the DataFetcher is not capable of monitoring the progress.

onFailed

public void onFailed(DataFetchException exception,
                     Long bytesFetched)

Description copied from interface: DataFetchProgressListener

Indicates that the process of fetching bytes from an InputStream has failed.

Specified by:

onFailed in interface DataFetchProgressListener

Parameters:

exception - The DataFetchException that caused the process to fail. This is the same DataFetchException that is thrown in the failing method of DataFetcher that this DataFetchProgressListener has been given to.

bytesFetched - Total total amount of bytes fetched before the process failed or null, if the DataFetcher is not capable of monitoring the progress.

onFinished

public void onFinished()

Description copied from interface: DataFetchProgressListener

Indicates that the process of fetching bytes from an InputStream has finished.

This method will be called after either DataFetchProgressListener.onSuccedded(Long) or DataFetchProgressListener.onFailed(DataFetchException, Long) has been called.

Specified by:

onFinished in interface DataFetchProgressListener