com.liulishuo.filedownloader

Class FileDownloadListener

java.lang.Object

com.liulishuo.filedownloader.FileDownloadListener

Direct Known Subclasses:

FileDownloadLargeFileListener, FileDownloadNotificationListener, FileDownloadSampleListener

public abstract class FileDownloadListener
extends java.lang.Object

Normally flow: pending(com.liulishuo.filedownloader.BaseDownloadTask, int, int) -> started(com.liulishuo.filedownloader.BaseDownloadTask) -> connected(com.liulishuo.filedownloader.BaseDownloadTask, java.lang.String, boolean, int, int) -> progress(com.liulishuo.filedownloader.BaseDownloadTask, int, int) -> blockComplete(com.liulishuo.filedownloader.BaseDownloadTask) -> completed(com.liulishuo.filedownloader.BaseDownloadTask)

Maybe over with: paused(com.liulishuo.filedownloader.BaseDownloadTask, int, int)/completed(com.liulishuo.filedownloader.BaseDownloadTask)/error(com.liulishuo.filedownloader.BaseDownloadTask, java.lang.Throwable)/warn(com.liulishuo.filedownloader.BaseDownloadTask)

If the task has already downloaded and exist, you will only receive follow callbacks: blockComplete(com.liulishuo.filedownloader.BaseDownloadTask) ->completed(com.liulishuo.filedownloader.BaseDownloadTask)

See Also:

FileDownloadLargeFileListener, FileDownloadNotificationListener, BaseDownloadTask.setSyncCallback(boolean)

Constructor Summary

Constructors

Constructor and Description
FileDownloadListener()
FileDownloadListener(int priority) Deprecated. not handle priority any more

Method Summary

Modifier and Type	Method and Description
protected void	blockComplete(BaseDownloadTask task) Unlike other methods in FileDownloadListener(int), BlockComplete is executed in other thread than main as default, when you receive this execution, it means has already completed downloading, but just block the execution of completed(BaseDownloadTask).
protected abstract void	completed(BaseDownloadTask task) Achieve complete ceremony.
protected void	connected(BaseDownloadTask task, java.lang.String etag, boolean isContinue, int soFarBytes, int totalBytes) Already connected to the server, and received the Http-response.
protected abstract void	error(BaseDownloadTask task, java.lang.Throwable e) Occur a exception, but don't has any chance to retry.
protected boolean	isInvalid() Whether this listener has already invalidated to receive callbacks.
protected abstract void	paused(BaseDownloadTask task, int soFarBytes, int totalBytes) Task is paused, the vast majority of cases is invoking the BaseDownloadTask.pause() manually.
protected abstract void	pending(BaseDownloadTask task, int soFarBytes, int totalBytes) Enqueue, and pending, waiting for started(BaseDownloadTask).
protected abstract void	progress(BaseDownloadTask task, int soFarBytes, int totalBytes) Fetching datum from network and Writing to the local disk.
protected void	retry(BaseDownloadTask task, java.lang.Throwable ex, int retryingTimes, int soFarBytes) Occur a exception and has chanceBaseDownloadTask.setAutoRetryTimes(int) to retry and start Retry.
protected void	started(BaseDownloadTask task) Finish pending, and start the download runnable.
protected abstract void	warn(BaseDownloadTask task) There has already had some same Tasks(Same-URL & Same-SavePath) in Pending-Queue or is running.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDownloadListener

public FileDownloadListener()

FileDownloadListener

public FileDownloadListener(int priority)

Deprecated. not handle priority any more

Parameters:

priority - not handle priority any more

Method Detail

isInvalid

protected boolean isInvalid()

Whether this listener has already invalidated to receive callbacks.

Returns:

true If you don't want to receive any callbacks for this listener.

pending

protected abstract void pending(BaseDownloadTask task,
                                int soFarBytes,
                                int totalBytes)

Enqueue, and pending, waiting for started(BaseDownloadTask).

Parameters:

task - The task

soFarBytes - Already downloaded and reusable bytes stored in the db

totalBytes - Total bytes stored in the db

See Also:

IFileDownloadMessenger.notifyPending(com.liulishuo.filedownloader.message.MessageSnapshot)

started

protected void started(BaseDownloadTask task)

Finish pending, and start the download runnable.

Parameters:

task - Current task.

See Also:

IFileDownloadMessenger.notifyStarted(com.liulishuo.filedownloader.message.MessageSnapshot)

connected

protected void connected(BaseDownloadTask task,
                         java.lang.String etag,
                         boolean isContinue,
                         int soFarBytes,
                         int totalBytes)

Already connected to the server, and received the Http-response.

Parameters:

task - The task

etag - ETag

isContinue - Is resume from breakpoint

soFarBytes - Number of bytes download so far

totalBytes - Total size of the download in bytes

See Also:

IFileDownloadMessenger.notifyConnected(com.liulishuo.filedownloader.message.MessageSnapshot)

progress

protected abstract void progress(BaseDownloadTask task,
                                 int soFarBytes,
                                 int totalBytes)

Fetching datum from network and Writing to the local disk.

Parameters:

task - The task

soFarBytes - Number of bytes download so far

totalBytes - Total size of the download in bytes

See Also:

IFileDownloadMessenger.notifyProgress(com.liulishuo.filedownloader.message.MessageSnapshot)

blockComplete

protected void blockComplete(BaseDownloadTask task)
                      throws java.lang.Throwable

Unlike other methods in FileDownloadListener(int), BlockComplete is executed in other thread than main as default, when you receive this execution, it means has already completed downloading, but just block the execution of completed(BaseDownloadTask). therefore, you can unzip or do some ending operation before completed(BaseDownloadTask) in other threads.

Parameters:

task - the current task

Throws:

java.lang.Throwable - if any throwable is thrown in this method, you will receive the callback method of error(BaseDownloadTask, Throwable) with the throwable parameter instead of completed(BaseDownloadTask)

See Also:

IFileDownloadMessenger.notifyBlockComplete(com.liulishuo.filedownloader.message.MessageSnapshot)

retry

protected void retry(BaseDownloadTask task,
                     java.lang.Throwable ex,
                     int retryingTimes,
                     int soFarBytes)

Occur a exception and has chanceBaseDownloadTask.setAutoRetryTimes(int) to retry and start Retry.

Parameters:

task - The task

ex - Why retry

retryingTimes - How many times will retry

soFarBytes - Number of bytes download so far

See Also:

IFileDownloadMessenger.notifyRetry(com.liulishuo.filedownloader.message.MessageSnapshot)

completed

protected abstract void completed(BaseDownloadTask task)

Achieve complete ceremony.

Complete downloading.

Parameters:

task - The task

See Also:

IFileDownloadMessenger.notifyCompleted(com.liulishuo.filedownloader.message.MessageSnapshot), blockComplete(BaseDownloadTask)

paused

protected abstract void paused(BaseDownloadTask task,
                               int soFarBytes,
                               int totalBytes)

Task is paused, the vast majority of cases is invoking the BaseDownloadTask.pause() manually.

Parameters:

task - The task

soFarBytes - Number of bytes download so far

totalBytes - Total size of the download in bytes

See Also:

IFileDownloadMessenger.notifyPaused(com.liulishuo.filedownloader.message.MessageSnapshot)

error

protected abstract void error(BaseDownloadTask task,
                              java.lang.Throwable e)

Occur a exception, but don't has any chance to retry.

Parameters:

task - The task

e - Any throwable on download pipeline

See Also:

IFileDownloadMessenger.notifyError(com.liulishuo.filedownloader.message.MessageSnapshot), FileDownloadHttpException, FileDownloadGiveUpRetryException, FileDownloadOutOfSpaceException

warn

protected abstract void warn(BaseDownloadTask task)

There has already had some same Tasks(Same-URL & Same-SavePath) in Pending-Queue or is running.

Parameters:

task - The task

See Also:

IFileDownloadMessenger.notifyWarn(com.liulishuo.filedownloader.message.MessageSnapshot)