BaseDownloadTask (library 1.7.6 API)

All Known Implementing Classes:

DownloadTask
```
public interface BaseDownloadTask
```
An atom download task.

See Also:

FileDownloader, ITaskHunter

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`BaseDownloadTask.FinishListener`
`static interface`	`BaseDownloadTask.InQueueTask` Declare the task will be assembled by a queue which makes up of the same listener task.
`static interface`	`BaseDownloadTask.IRunningTask` The running task.
`static interface`	`BaseDownloadTask.LifeCycleCallback` The callback for the life cycle of the task.

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_CALLBACK_PROGRESS_MIN_INTERVAL_MILLIS

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_CALLBACK_PROGRESS_MIN_INTERVAL_MILLIS`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`BaseDownloadTask`	`addFinishListener(BaseDownloadTask.FinishListener finishListener)` Add the finish listener to listen when the task is finished.
`BaseDownloadTask`	`addHeader(java.lang.String line)` Add a field with the specified value to the request header.
`BaseDownloadTask`	`addHeader(java.lang.String name, java.lang.String value)` Add the params to the request header.
`BaseDownloadTask.InQueueTask`	`asInQueueTask()` Declare the task will be assembled by a queue which makes up of the same listener task.
`boolean`	`cancel()` Deprecated. replace with `pause()`
`int`	`getAutoRetryTimes()`
`int`	`getCallbackProgressMinInterval()`
`int`	`getCallbackProgressTimes()`
`int`	`getDownloadId()` Deprecated. Used `getId()` instead.
`java.lang.Throwable`	`getErrorCause()`
`java.lang.String`	`getEtag()`
`java.lang.Throwable`	`getEx()` Deprecated. Replaced with `getErrorCause()`
`java.lang.String`	`getFilename()`
`int`	`getId()` The downloading identify of this task, what is generated by `getUrl()` and `getPath()` and `isPathAsDirectory()` from `FileDownloadUtils.generateId(String, String)`.
`long`	`getLargeFileSoFarBytes()` This method will be used when the length of target file is more than 1.99G.
`long`	`getLargeFileTotalBytes()` This method will be used when the length of target file is more than 1.99G.
`FileDownloadListener`	`getListener()`
`java.lang.String`	`getPath()`
`int`	`getRetryingTimes()`
`int`	`getSmallFileSoFarBytes()` This method will be used when the length of target file is less than or equal to 1.99G.
`int`	`getSmallFileTotalBytes()` This method will be used when the length of target file is less than or equal to 1.99G.
`int`	`getSoFarBytes()` Deprecated. replace with `getSmallFileSoFarBytes()`.
`int`	`getSpeed()` Get the downloading speed.
`byte`	`getStatus()`
`java.lang.Object`	`getTag()`
`java.lang.Object`	`getTag(int key)` Returns the tag associated with this task and the specified key.
`java.lang.String`	`getTargetFilePath()`
`int`	`getTotalBytes()` Deprecated. replace with `getSmallFileTotalBytes()`}
`java.lang.String`	`getUrl()`
`boolean`	`isAttached()` Whether this task has already attached to a listener / a serial-queue.
`boolean`	`isContinue()` Deprecated. Use `isResuming()` instead.
`boolean`	`isForceReDownload()`
`boolean`	`isLargeFile()`
`boolean`	`isPathAsDirectory()`
`boolean`	`isResuming()`
`boolean`	`isReusedOldFile()`
`boolean`	`isRunning()`
`boolean`	`isSyncCallback()`
`boolean`	`isUsing()`
`boolean`	`isWifiRequired()`
`boolean`	`pause()` Why pause? not stop/cancel? because invoke this method(pause) will clear all data about this task in memory, and stop the total processing about this task.
`int`	`ready()` Deprecated. please use `asInQueueTask()` first and when you need to enqueue this task to the global queue to make this task is ready to be assembled by the queue which makes up of the same listener task, just invoke `BaseDownloadTask.InQueueTask.enqueue()`.
`BaseDownloadTask`	`removeAllHeaders(java.lang.String name)` Remove all fields in the request header.
`boolean`	`removeFinishListener(BaseDownloadTask.FinishListener finishListener)` Remove the finish listener from this task.
`boolean`	`reuse()` Reuse this task withhold request params: path、url、header、isForceReDownloader、etc.
`BaseDownloadTask`	`setAutoRetryTimes(int autoRetryTimes)` Set the number of times to retry when encounter any error, except `FileDownloadGiveUpRetryException`.
`BaseDownloadTask`	`setCallbackProgressIgnored()` Ignore all callbacks of `FileDownloadListener.progress(BaseDownloadTask, int, int)` during the entire process of downloading.
`BaseDownloadTask`	`setCallbackProgressMinInterval(int minIntervalMillis)` Set the minimum time interval between each callback of `FileDownloadListener.progress(BaseDownloadTask, int, int)`.
`BaseDownloadTask`	`setCallbackProgressTimes(int callbackProgressCount)` Set the maximum callback count of `FileDownloadListener.progress(BaseDownloadTask, int, int)` during the entire process of downloading.
`BaseDownloadTask`	`setFinishListener(BaseDownloadTask.FinishListener finishListener)` Deprecated. Replace with `addFinishListener(FinishListener)`
`BaseDownloadTask`	`setForceReDownload(boolean isForceReDownload)` Force re-downloading the file regardless the target file is exist.
`BaseDownloadTask`	`setListener(FileDownloadListener listener)`
`BaseDownloadTask`	`setMinIntervalUpdateSpeed(int minIntervalUpdateSpeedMs)`
`BaseDownloadTask`	`setPath(java.lang.String path)`
`BaseDownloadTask`	`setPath(java.lang.String path, boolean pathAsDirectory)`
`BaseDownloadTask`	`setSyncCallback(boolean syncCallback)`
`BaseDownloadTask`	`setTag(int key, java.lang.Object tag)` Set a tag associated with this task, not be used by internal.
`BaseDownloadTask`	`setTag(java.lang.Object tag)` Sets the tag associated with this task, not be used by internal.
`BaseDownloadTask`	`setWifiRequired(boolean isWifiRequired)` Set whether this task only allows downloading on the wifi network type.
`int`	`start()` Start this task in parallel.

- Field Detail
  - DEFAULT_CALLBACK_PROGRESS_MIN_INTERVAL_MILLIS
```
static final int DEFAULT_CALLBACK_PROGRESS_MIN_INTERVAL_MILLIS
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setMinIntervalUpdateSpeed
```
BaseDownloadTask setMinIntervalUpdateSpeed(int minIntervalUpdateSpeedMs)
```
    Parameters:
    
    minIntervalUpdateSpeedMs - The minimum interval millisecond for updating the downloading speed in downloading process(Status equal to progress).
    Default: 5 ms.
    If the value is less than or equal to 0, will not calculate the download speed in process.
  - setPath
```
BaseDownloadTask setPath(java.lang.String path)
```
    Parameters:
    
    path - path = (absolute directory/filename); and isPathAsDirectory() assign to false.
  - setPath
```
BaseDownloadTask setPath(java.lang.String path,
                         boolean pathAsDirectory)
```
    Parameters:
    
    path - The absolute path for saving the download file.
    
    pathAsDirectory - true: if the path is absolute directory to store the downloading file, and the filename will be found in contentDisposition from the response as default, if can't find contentDisposition,the filename will be generated by FileDownloadUtils.generateFileName(String) with url.
    false: if the path = (absolute directory/filename).
    
    See Also:
    
    isPathAsDirectory(), getFilename()
  - setListener
```
BaseDownloadTask setListener(FileDownloadListener listener)
```
    Parameters:
    
    listener - For callback download status(pending,connected,progress, blockComplete,retry,error,paused,completed,warn)
  - setCallbackProgressTimes
```
BaseDownloadTask setCallbackProgressTimes(int callbackProgressCount)
```
    Set the maximum callback count of FileDownloadListener.progress(BaseDownloadTask, int, int) during the entire process of downloading.
    Note: this function will not work if the URL is refer to 'chucked' resource.
    
    Parameters:
    
    callbackProgressCount - The maximum callback count of FileDownloadListener.progress(com.liulishuo.filedownloader.BaseDownloadTask, int, int) during the entire process of downloading.
    Default value is 100, If the value less than or equal to 0, you will not receive any callback of FileDownloadListener.progress(com.liulishuo.filedownloader.BaseDownloadTask, int, int) .
    
    See Also:
    
    setCallbackProgressMinInterval(int)
  - setCallbackProgressMinInterval
```
BaseDownloadTask setCallbackProgressMinInterval(int minIntervalMillis)
```
    Set the minimum time interval between each callback of FileDownloadListener.progress(BaseDownloadTask, int, int).
    
    Parameters:
    
    minIntervalMillis - The minimum interval between each callback of FileDownloadListener.progress(BaseDownloadTask, int, int).
    Unit: millisecond.
    Default value is DEFAULT_CALLBACK_PROGRESS_MIN_INTERVAL_MILLIS.
    Scope: [5, Integer.MAX_VALUE.
    
    See Also:
    
    setCallbackProgressTimes(int)
  - setCallbackProgressIgnored
```
BaseDownloadTask setCallbackProgressIgnored()
```
    Ignore all callbacks of FileDownloadListener.progress(BaseDownloadTask, int, int) during the entire process of downloading. This will optimize the performance.
  - setTag
```
BaseDownloadTask setTag(java.lang.Object tag)
```
    Sets the tag associated with this task, not be used by internal.
  - setTag
```
BaseDownloadTask setTag(int key,
                        java.lang.Object tag)
```
    Set a tag associated with this task, not be used by internal.
    
    Parameters:
    
    key - The key of identifying the tag. If the key already exists, the old data will be replaced.
    
    tag - An Object to tag the task with
  - setForceReDownload
```
BaseDownloadTask setForceReDownload(boolean isForceReDownload)
```
    Force re-downloading the file regardless the target file is exist.
    
    Parameters:
    
    isForceReDownload - If set to true, will not check whether the target file is exist.
    Default: false.
  - setFinishListener
```
BaseDownloadTask setFinishListener(BaseDownloadTask.FinishListener finishListener)
```
    Deprecated. Replace with addFinishListener(FinishListener)
  - addFinishListener
```
BaseDownloadTask addFinishListener(BaseDownloadTask.FinishListener finishListener)
```
    Add the finish listener to listen when the task is finished.
    This listener's method BaseDownloadTask.FinishListener.over(BaseDownloadTask) will be invoked in Internal-Flow-Thread directly, which is controlled by MessageSnapshotThreadPool.
    
    Parameters:
    
    finishListener - The finish listener.
    
    See Also:
    
    FileDownloadStatus.isOver(int)
  - removeFinishListener
```
boolean removeFinishListener(BaseDownloadTask.FinishListener finishListener)
```
    Remove the finish listener from this task.
    
    Parameters:
    
    finishListener - The finish listener.
    
    Returns:
    
    true if remove the finishListener successfully. false otherwise.
  - setAutoRetryTimes
```
BaseDownloadTask setAutoRetryTimes(int autoRetryTimes)
```
    Set the number of times to retry when encounter any error, except FileDownloadGiveUpRetryException.
    
    Parameters:
    
    autoRetryTimes - The retry times, default 0.
  - addHeader
```
BaseDownloadTask addHeader(java.lang.String name,
                           java.lang.String value)
```
    Add the params to the request header.
    Note: We have already handled Etag internal for guaranteeing tasks resuming from the breakpoint, in other words, if the task has downloaded and got Etag, we will add the 'If-Match' and the 'Range' K-V to its request header automatically.
  - addHeader
```
BaseDownloadTask addHeader(java.lang.String line)
```
    Add a field with the specified value to the request header.
  - removeAllHeaders
```
BaseDownloadTask removeAllHeaders(java.lang.String name)
```
    Remove all fields in the request header.
  - setSyncCallback
```
BaseDownloadTask setSyncCallback(boolean syncCallback)
```
    Parameters:
    
    syncCallback - true FileDownloader will invoke methods of FileDownloadListener directly on the download thread(isn't in the main thread).
  - setWifiRequired
```
BaseDownloadTask setWifiRequired(boolean isWifiRequired)
```
    Set whether this task only allows downloading on the wifi network type. Default false
    Note: If isWifiRequired is true, FileDownloader will check the network type every time after fetch less than or equal to 4096 bytes data from the network, what will result in slowing the download speed slightly.
    Permission: If isWifiRequired is true, You need declare the permission Manifest.permission.ACCESS_NETWORK_STATE in your manifest, let FileDownloader has permission to check the network type in downloading, if you start this task without this permission you will receive a FileDownloadGiveUpRetryException.
    
    Parameters:
    
    isWifiRequired - true This task only allow to download on the wifi network type.
  - ready
```
int ready()
```
    Deprecated. please use asInQueueTask() first and when you need to enqueue this task to the global queue to make this task is ready to be assembled by the queue which makes up of the same listener task, just invoke BaseDownloadTask.InQueueTask.enqueue().
    
    Ready this task(For the task in a queue).
    Note: If this task doesn't belong to a queue, what is just an isolated task, you just need to invoke start() to start this task, that's all. In other words, If this task doesn't belong to a queue, you must not invoke this method or BaseDownloadTask.InQueueTask.enqueue() method before invoke start(), If you do that and if there is the same listener object to start a queue in another thread, this task may be assembled by the queue, in that case, when you invoke start() manually to start this task or this task is started by the queue, there is an exception buried in there, because this task object is started two times without declare reuse() : 1. you invoke start() manually; 2. the queue start this task automatically.
    
    Returns:
    
    downloadId the download identify.
    
    See Also:
    
    FileDownloader.start(FileDownloadListener, boolean)
  - asInQueueTask
```
BaseDownloadTask.InQueueTask asInQueueTask()
```
    Declare the task will be assembled by a queue which makes up of the same listener task.
    Note: If you use FileDownloadQueueSet to start this task in a queue, you don't need to invoke this method manually, it has been handled by FileDownloadQueueSet.
    
    Returns:
    
    the task which is in a queue and exposes method BaseDownloadTask.InQueueTask.enqueue() to enqueue this task to the global queue to ready for being assembled by the queue.
  - reuse
```
boolean reuse()
```
    Reuse this task withhold request params: path、url、header、isForceReDownloader、etc.
    Note:If the task has been over(FileDownloadStatus.isOver(int)), but the over-message has not been handover to the listener, since the callback is asynchronous, once your invoke this 'reuse' method, that message would be discard, for free the messenger.
    
    Returns:
    
    true if reuse this task successfully. false otherwise.
  - isUsing
```
boolean isUsing()
```
    Returns:
    
    true if the this task already has downloading data, it means that this task is running or has ran.
    
    See Also:
    
    isRunning(), start(), reuse()
  - isRunning
```
boolean isRunning()
```
    Returns:
    
    true if this task is running, in this case, this task isn't allow to start() again for this task object, and even not allow to reuse(). false this task maybe isUsing() or in idle.
    
    See Also:
    
    isUsing(), start()
  - isAttached
```
boolean isAttached()
```
    Whether this task has already attached to a listener / a serial-queue.
    
    Returns:
    
    true if this task is running, and it has already attached to the listener or has already assembled to a serial-queue and would be started automatically when it is come to its turn.
    
    See Also:
    
    IQueuesHandler.startQueueSerial(FileDownloadListener), IQueuesHandler.startQueueParallel(FileDownloadListener)
  - start
```
int start()
```
    Start this task in parallel.
    
    Returns:
    
    The download id.
  - pause
```
boolean pause()
```
    Why pause? not stop/cancel? because invoke this method(pause) will clear all data about this task in memory, and stop the total processing about this task. but when you start the paused task, it would be continue downloading from the breakpoint as default.
    
    Returns:
    
    true, if pause this task successfully, false otherwise this task has already in over status before invoke this method(this case maybe occurred in high concurrent situation).
    
    See Also:
    
    FileDownloader.pause(int), FileDownloader.pause(FileDownloadListener), FileDownloader.pauseAll()
  - cancel
```
boolean cancel()
```
    Deprecated. replace with pause()
    
    The pause() also clear all data relate with this task in the memory, so please use pause() instead.
    
    Returns:
    
    true if cancel this task successfully.
  - getId
```
int getId()
```
    The downloading identify of this task, what is generated by getUrl() and getPath() and isPathAsDirectory() from FileDownloadUtils.generateId(String, String).
    
    Returns:
    
    The downloading identify of this task.
    
    See Also:
    
    FileDownloader.pause(int), FileDownloader.getStatus(String, String), FileDownloader.getTotal(int), FileDownloader.getSoFar(int)
  - getDownloadId
```
int getDownloadId()
```
    Deprecated. Used getId() instead.
    
    Returns:
    
    The downloading identify of this task.
  - getUrl
```
java.lang.String getUrl()
```
    Returns:
    
    The Url.
  - getCallbackProgressTimes
```
int getCallbackProgressTimes()
```
    Returns:
    
    The maximum callback count of FileDownloadListener.progress(BaseDownloadTask, int, int) during the entire process of downloading.
  - getCallbackProgressMinInterval
```
int getCallbackProgressMinInterval()
```
    Returns:
    
    The minimum time interval between each callback of FileDownloadListener.progress(BaseDownloadTask, int, int) .
  - getPath
```
java.lang.String getPath()
```
    Returns:
    
    If isPathAsDirectory() is true: path is a absolute directory to store the downloading file, and the filename will be found in contentDisposition from the response as default, if can't find contentDisposition, the filename will be generated by FileDownloadUtils.generateFileName(String) with url. otherwise path is the absolute path of the target file.
  - isPathAsDirectory
```
boolean isPathAsDirectory()
```
    Returns:
    
    Whether the result of getPath() is a directory.
    
    See Also:
    
    getPath()
  - getFilename
```
java.lang.String getFilename()
```
    Returns:
    
    If isPathAsDirectory() is true, the filename will be found in contentDisposition from the response as default, if can't find contentDisposition, the filename will be generated by FileDownloadUtils.generateFileName(String) with url. It will be found before the callback of FileDownloadListener.connected(BaseDownloadTask, String, boolean, int, int).
    If isPathAsDirectory() is false, the filename will be found immediately when you invoke setPath(String, boolean) .
  - getTargetFilePath
```
java.lang.String getTargetFilePath()
```
    Returns:
    
    The target file path to store the file.
  - getListener
```
FileDownloadListener getListener()
```
    Returns:
    
    the downloading listener.
  - getSoFarBytes
```
int getSoFarBytes()
```
    Deprecated. replace with getSmallFileSoFarBytes().
    
    Returns:
    
    The has already downloaded bytes so far.
  - getSmallFileSoFarBytes
```
int getSmallFileSoFarBytes()
```
    This method will be used when the length of target file is less than or equal to 1.99G.
    
    Returns:
    
    The has already downloaded bytes so far.
  - getLargeFileSoFarBytes
```
long getLargeFileSoFarBytes()
```
    This method will be used when the length of target file is more than 1.99G.
    
    Returns:
    
    The has already downloaded bytes so far.
  - getTotalBytes
```
int getTotalBytes()
```
    Deprecated. replace with getSmallFileTotalBytes()}
    
    Returns:
    
    The total bytes of the target file.
    Note: this value will be valid after FileDownloadListener.connected(BaseDownloadTask, String, boolean, int, int) or it has already have in the database.
  - getSmallFileTotalBytes
```
int getSmallFileTotalBytes()
```
    This method will be used when the length of target file is less than or equal to 1.99G.
    
    Returns:
    
    The total bytes of the target file.
  - getLargeFileTotalBytes
```
long getLargeFileTotalBytes()
```
    This method will be used when the length of target file is more than 1.99G.
    
    Returns:
    
    The total bytes of the target file.
  - getSpeed
```
int getSpeed()
```
    Get the downloading speed.
    If the task is in the downloading process(status equal FileDownloadStatus.progress) : The value is a real-time speed. it is calculated when the interval from the last calculation more than setMinIntervalUpdateSpeed(int) before each FileDownloadListener.progress(BaseDownloadTask, int, int) call-back method.
    If this task is finished(FileDownloadStatus.isOver(int)): The value is a average speed. it is calculated from the entire downloading travel(connected, over).
    
    Returns:
    
    The downloading speed, Unit: KB/s.
    
    See Also:
    
    setMinIntervalUpdateSpeed(int)
  - getStatus
```
byte getStatus()
```
    Returns:
    
    The downloading status.
    
    See Also:
    
    FileDownloadStatus
  - isForceReDownload
```
boolean isForceReDownload()
```
    Returns:
    
    true if this task force re-download regard less the target file has already exist.
  - getEx
```
java.lang.Throwable getEx()
```
    Deprecated. Replaced with getErrorCause()
  - getErrorCause
```
java.lang.Throwable getErrorCause()
```
    Returns:
    
    The error cause.
  - isReusedOldFile
```
boolean isReusedOldFile()
```
    Returns:
    
    true if this task didn't start downloading really, because the target file has already exist. false otherwise.
    
    See Also:
    
    isForceReDownload()
  - getTag
```
java.lang.Object getTag()
```
    Returns:
    
    The tag.
  - getTag
```
java.lang.Object getTag(int key)
```
    Returns the tag associated with this task and the specified key.
    
    Parameters:
    
    key - The key identifying the tag.
    
    Returns:
    
    the object stored in this take as a tag, or null if not set.
    
    See Also:
    
    setTag(int, Object), getTag()
  - isContinue
```
boolean isContinue()
```
    Deprecated. Use isResuming() instead.
  - isResuming
```
boolean isResuming()
```
    Returns:
    
    true if this task is resuming from the breakpoint, this value is valid after FileDownloadListener.connected(BaseDownloadTask, String, boolean, int, int).
  - getEtag
```
java.lang.String getEtag()
```
    Returns:
    
    The ETag from the response's header, this value is valid after FileDownloadListener.connected(BaseDownloadTask, String, boolean, int, int)
  - getAutoRetryTimes
```
int getAutoRetryTimes()
```
    Returns:
    
    The number of times has set to retry when occur any error.
    
    See Also:
    
    setAutoRetryTimes(int)
  - getRetryingTimes
```
int getRetryingTimes()
```
    Returns:
    
    The currently number of times of retry.this value is valid after FileDownloadListener.retry(BaseDownloadTask, Throwable, int, int)
  - isSyncCallback
```
boolean isSyncCallback()
```
    Returns:
    
    true if the methods of FileDownloadListener will be invoked directly in message-thread for this task, false all methods of FileDownloadListener will be post to the UI thread for this task.
    
    See Also:
    
    setSyncCallback(boolean)
  - isLargeFile
```
boolean isLargeFile()
```
    Returns:
    
    true if the length of target file is more than or equal to 2G.
    
    See Also:
    
    getLargeFileSoFarBytes(), getLargeFileTotalBytes()
  - isWifiRequired
```
boolean isWifiRequired()
```
    Returns:
    
    true if this task has been set only allows downloading on the wifi network type.

Interface BaseDownloadTask

Nested Class Summary

Field Summary

Method Summary

Field Detail

DEFAULT_CALLBACK_PROGRESS_MIN_INTERVAL_MILLIS

Method Detail

setMinIntervalUpdateSpeed

setPath

setPath

setListener

setCallbackProgressTimes

setCallbackProgressMinInterval

setCallbackProgressIgnored

setTag

setTag

setForceReDownload

setFinishListener

addFinishListener

removeFinishListener

setAutoRetryTimes

addHeader

addHeader

removeAllHeaders

setSyncCallback

setWifiRequired

ready

asInQueueTask

reuse

isUsing

isRunning

isAttached

start

pause

cancel

getId

getDownloadId

getUrl

getCallbackProgressTimes

getCallbackProgressMinInterval

getPath

isPathAsDirectory

getFilename

getTargetFilePath

getListener

getSoFarBytes

getSmallFileSoFarBytes

getLargeFileSoFarBytes

getTotalBytes

getSmallFileTotalBytes

getLargeFileTotalBytes

getSpeed

getStatus

isForceReDownload

getEx

getErrorCause

isReusedOldFile

getTag

getTag

isContinue

isResuming

getEtag

getAutoRetryTimes

getRetryingTimes

isSyncCallback

isLargeFile

isWifiRequired