com.liulishuo.filedownloader.notification

Class FileDownloadNotificationListener

java.lang.Object

com.liulishuo.filedownloader.FileDownloadListener

com.liulishuo.filedownloader.notification.FileDownloadNotificationListener

public abstract class FileDownloadNotificationListener
extends FileDownloadListener

The listener of the notification with the task.

See Also:

FileDownloadNotificationHelper, BaseNotificationItem

Constructor Summary

Constructors

Constructor and Description
FileDownloadNotificationListener(FileDownloadNotificationHelper helper)

Method Summary

Modifier and Type	Method and Description
void	addNotificationItem(BaseDownloadTask task)
void	addNotificationItem(int downloadId)
protected void	blockComplete(BaseDownloadTask task) Unlike other methods in FileDownloadListener.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 FileDownloadListener.completed(BaseDownloadTask).
protected void	completed(BaseDownloadTask task) Achieve complete ceremony.
protected abstract BaseNotificationItem	create(BaseDownloadTask task)
void	destroyNotification(BaseDownloadTask task) The notification item with the task is told to destroy.
protected boolean	disableNotification(BaseDownloadTask task)
protected void	error(BaseDownloadTask task, Throwable e) Occur a exception, but don't has any chance to retry.
FileDownloadNotificationHelper	getHelper()
protected boolean	interceptCancel(BaseDownloadTask task, BaseNotificationItem notificationItem)
protected void	paused(BaseDownloadTask task, int soFarBytes, int totalBytes) Task is paused, the vast majority of cases is invoking the BaseDownloadTask.pause() manually.
protected void	pending(BaseDownloadTask task, int soFarBytes, int totalBytes) Enqueue, and pending, waiting for FileDownloadListener.started(BaseDownloadTask).
protected void	progress(BaseDownloadTask task, int soFarBytes, int totalBytes) Fetching datum from network and Writing to the local disk.
protected void	retry(BaseDownloadTask task, Throwable ex, int retryingTimes, int soFarBytes) Occur a exception and has chanceBaseDownloadTask.setAutoRetryTimes(int) to retry and start Retry.
void	showIndeterminate(BaseDownloadTask task)
void	showProgress(BaseDownloadTask task, int soFarBytes, int totalBytes)
protected void	started(BaseDownloadTask task) Finish pending, and start the download runnable.
protected 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 com.liulishuo.filedownloader.FileDownloadListener

connected, isInvalid

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDownloadNotificationListener

public FileDownloadNotificationListener(FileDownloadNotificationHelper helper)

Method Detail

getHelper

public FileDownloadNotificationHelper getHelper()

addNotificationItem

public void addNotificationItem(int downloadId)

addNotificationItem

public void addNotificationItem(BaseDownloadTask task)

destroyNotification

public void destroyNotification(BaseDownloadTask task)

The notification item with the task is told to destroy.

Parameters:

task - The task used to identify the will be destroyed notification item.

showIndeterminate

public void showIndeterminate(BaseDownloadTask task)

showProgress

public void showProgress(BaseDownloadTask task,
                         int soFarBytes,
                         int totalBytes)

create

protected abstract BaseNotificationItem create(BaseDownloadTask task)

Parameters:

task - The task used to bind with the will be created notification item.

Returns:

The notification item is related with the task.

interceptCancel

protected boolean interceptCancel(BaseDownloadTask task,
                                  BaseNotificationItem notificationItem)

Parameters:

task - The task.

notificationItem - The notification item.

Returns:

true if you want to survive the notification item, and we will don't cancel the relate notification from the notification panel when the relate task is finished, false otherwise.

Default: false

See Also:

destroyNotification(BaseDownloadTask)

disableNotification

protected boolean disableNotification(BaseDownloadTask task)

Parameters:

task - The task.

Returns:

true if you want to disable the internal notification lifecycle, and in this case all method about the notification will be invalid, false otherwise.

Default: false

pending

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

Description copied from class: FileDownloadListener

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

Specified by:

pending in class FileDownloadListener

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)

Description copied from class: FileDownloadListener

Finish pending, and start the download runnable.

Overrides:

started in class FileDownloadListener

Parameters:

task - Current task.

See Also:

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

progress

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

Description copied from class: FileDownloadListener

Fetching datum from network and Writing to the local disk.

Specified by:

progress in class FileDownloadListener

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)

retry

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

Description copied from class: FileDownloadListener

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

Overrides:

retry in class FileDownloadListener

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)

blockComplete

protected void blockComplete(BaseDownloadTask task)

Description copied from class: FileDownloadListener

Unlike other methods in FileDownloadListener.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 FileDownloadListener.completed(BaseDownloadTask). therefore, you can unzip or do some ending operation before FileDownloadListener.completed(BaseDownloadTask) in other threads.

Overrides:

blockComplete in class FileDownloadListener

Parameters:

task - the current task

See Also:

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

completed

protected void completed(BaseDownloadTask task)

Description copied from class: FileDownloadListener

Achieve complete ceremony.

Complete downloading.

Specified by:

completed in class FileDownloadListener

Parameters:

task - The task

See Also:

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

paused

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

Description copied from class: FileDownloadListener

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

Specified by:

paused in class FileDownloadListener

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 void error(BaseDownloadTask task,
                     Throwable e)

Description copied from class: FileDownloadListener

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

Specified by:

error in class FileDownloadListener

Parameters:

task - The task

e - Any throwable on download pipeline

See Also:

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

warn

protected void warn(BaseDownloadTask task)

Description copied from class: FileDownloadListener

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

Specified by:

warn in class FileDownloadListener

Parameters:

task - The task

See Also:

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