DownloadTask (library 1.7.5 API)

java.lang.Object
- com.liulishuo.filedownloader.DownloadTask

All Implemented Interfaces:: BaseDownloadTask, BaseDownloadTask.IRunningTask

public class DownloadTask
extends Object
implements BaseDownloadTask, BaseDownloadTask.IRunningTask

The download task.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.liulishuo.filedownloader.BaseDownloadTask
  BaseDownloadTask.FinishListener, BaseDownloadTask.InQueueTask, BaseDownloadTask.IRunningTask, BaseDownloadTask.LifeCycleCallback

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 Concrete 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(String line)` Add a field with the specified value to the request header.
`BaseDownloadTask`	`addHeader(String name, 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()` The `BaseDownloadTask.pause()` also clear all data relate with this task in the memory, so please use `BaseDownloadTask.pause()` instead.
`void`	`free()` Free the task.
`int`	`getAttachKey()` When the task is running, it must attach a key.
`int`	`getAutoRetryTimes()`
`int`	`getCallbackProgressMinInterval()`
`int`	`getCallbackProgressTimes()`
`int`	`getDownloadId()` Deprecated. Used `getId()` instead.
`Throwable`	`getErrorCause()`
`String`	`getEtag()`
`Throwable`	`getEx()`
`String`	`getFilename()`
`ArrayList<BaseDownloadTask.FinishListener>`	`getFinishListenerList()`
`FileDownloadHeader`	`getHeader()`
`int`	`getId()` The downloading identify of this task, what is generated by `BaseDownloadTask.getUrl()` and `BaseDownloadTask.getPath()` and `BaseDownloadTask.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()`
`ITaskHunter.IMessageHandler`	`getMessageHandler()`
`BaseDownloadTask`	`getOrigin()`
`String`	`getPath()`
`Object`	`getPauseLock()` Get the object as a lock for synchronized with the pause area.
`int`	`getRetryingTimes()`
`BaseDownloadTask.IRunningTask`	`getRunningTask()`
`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()`
`int`	`getSpeed()` Get the downloading speed.
`byte`	`getStatus()`
`Object`	`getTag()`
`Object`	`getTag(int key)` Returns the tag associated with this task and the specified key.
`String`	`getTargetFilePath()`
`int`	`getTotalBytes()`
`String`	`getUrl()`
`boolean`	`is(FileDownloadListener listener)`
`boolean`	`is(int id)`
`boolean`	`isAttached()` Whether this task has already attached to a listener / a serial-queue.
`boolean`	`isContainFinishListener()` Whether contain finish listener or not.
`boolean`	`isContinue()` Deprecated. Use `isResuming()` instead.
`boolean`	`isForceReDownload()`
`boolean`	`isLargeFile()`
`boolean`	`isMarkedAdded2List()`
`boolean`	`isOver()`
`boolean`	`isPathAsDirectory()`
`boolean`	`isResuming()`
`boolean`	`isReusedOldFile()`
`boolean`	`isRunning()`
`boolean`	`isSyncCallback()`
`boolean`	`isUsing()`
`boolean`	`isWifiRequired()`
`void`	`markAdded2List()` Mark the task has already added to the downloading list.
`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()` Ready this task(For the task in a queue).
`BaseDownloadTask`	`removeAllHeaders(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.
`void`	`setAttachKeyByQueue(int key)` Set this task attach to the `key` by the queue.
`void`	`setAttachKeyDefault()` Set this task to the default key.
`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.
`void`	`setFileName(String fileName)`
`BaseDownloadTask`	`setFinishListener(BaseDownloadTask.FinishListener 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(String path)`
`BaseDownloadTask`	`setPath(String path, boolean pathAsDirectory)`
`BaseDownloadTask`	`setSyncCallback(boolean syncCallback)`
`BaseDownloadTask`	`setTag(int key, Object tag)` Set a tag associated with this task, not be used by internal.
`BaseDownloadTask`	`setTag(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.
`void`	`startTaskByQueue()` Start the task by the queue handler.
`void`	`startTaskByRescue()` Start the task just because this task can't started by pass, and now, we try to rescue this task and start it.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_CALLBACK_PROGRESS_MIN_INTERVAL_MILLIS
```
public static final int DEFAULT_CALLBACK_PROGRESS_MIN_INTERVAL_MILLIS
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setMinIntervalUpdateSpeed
```
public BaseDownloadTask setMinIntervalUpdateSpeed(int minIntervalUpdateSpeedMs)
```
    Specified by:
    
    setMinIntervalUpdateSpeed in interface BaseDownloadTask
    
    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
```
public BaseDownloadTask setPath(String path)
```
    Specified by:
    
    setPath in interface BaseDownloadTask
    
    Parameters:
    
    path - path = (absolute directory/filename); and BaseDownloadTask.isPathAsDirectory() assign to false.
  - setPath
```
public BaseDownloadTask setPath(String path,
                                boolean pathAsDirectory)
```
    Specified by:
    
    setPath in interface BaseDownloadTask
    
    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:
    
    BaseDownloadTask.isPathAsDirectory(), BaseDownloadTask.getFilename()
  - setListener
```
public BaseDownloadTask setListener(FileDownloadListener listener)
```
    Specified by:
    
    setListener in interface BaseDownloadTask
    
    Parameters:
    
    listener - For callback download status(pending,connected,progress, blockComplete,retry,error,paused,completed,warn)
  - setCallbackProgressTimes
```
public BaseDownloadTask setCallbackProgressTimes(int callbackProgressCount)
```
    Description copied from interface: BaseDownloadTask
    
    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.
    
    Specified by:
    
    setCallbackProgressTimes in interface BaseDownloadTask
    
    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:
    
    BaseDownloadTask.setCallbackProgressMinInterval(int)
  - setCallbackProgressMinInterval
```
public BaseDownloadTask setCallbackProgressMinInterval(int minIntervalMillis)
```
    Description copied from interface: BaseDownloadTask
    
    Set the minimum time interval between each callback of FileDownloadListener.progress(BaseDownloadTask, int, int).
    
    Specified by:
    
    setCallbackProgressMinInterval in interface BaseDownloadTask
    
    Parameters:
    
    minIntervalMillis - The minimum interval between each callback of FileDownloadListener.progress(BaseDownloadTask, int, int).
    Unit: millisecond.
    Default value is BaseDownloadTask.DEFAULT_CALLBACK_PROGRESS_MIN_INTERVAL_MILLIS.
    Scope: [5, Integer.MAX_VALUE.
    
    See Also:
    
    BaseDownloadTask.setCallbackProgressTimes(int)
  - setCallbackProgressIgnored
```
public BaseDownloadTask setCallbackProgressIgnored()
```
    Description copied from interface: BaseDownloadTask
    
    Ignore all callbacks of FileDownloadListener.progress(BaseDownloadTask, int, int) during the entire process of downloading. This will optimize the performance.
    
    Specified by:
    
    setCallbackProgressIgnored in interface BaseDownloadTask
  - setTag
```
public BaseDownloadTask setTag(Object tag)
```
    Description copied from interface: BaseDownloadTask
    
    Sets the tag associated with this task, not be used by internal.
    
    Specified by:
    
    setTag in interface BaseDownloadTask
  - setTag
```
public BaseDownloadTask setTag(int key,
                               Object tag)
```
    Description copied from interface: BaseDownloadTask
    
    Set a tag associated with this task, not be used by internal.
    
    Specified by:
    
    setTag in interface BaseDownloadTask
    
    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
```
public BaseDownloadTask setForceReDownload(boolean isForceReDownload)
```
    Description copied from interface: BaseDownloadTask
    
    Force re-downloading the file regardless the target file is exist.
    
    Specified by:
    
    setForceReDownload in interface BaseDownloadTask
    
    Parameters:
    
    isForceReDownload - If set to true, will not check whether the target file is exist.
    Default: false.
  - setFinishListener
```
public BaseDownloadTask setFinishListener(BaseDownloadTask.FinishListener finishListener)
```
    Specified by:
    
    setFinishListener in interface BaseDownloadTask
  - addFinishListener
```
public BaseDownloadTask addFinishListener(BaseDownloadTask.FinishListener finishListener)
```
    Description copied from interface: BaseDownloadTask
    
    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.
    
    Specified by:
    
    addFinishListener in interface BaseDownloadTask
    
    Parameters:
    
    finishListener - The finish listener.
    
    See Also:
    
    FileDownloadStatus.isOver(int)
  - removeFinishListener
```
public boolean removeFinishListener(BaseDownloadTask.FinishListener finishListener)
```
    Description copied from interface: BaseDownloadTask
    
    Remove the finish listener from this task.
    
    Specified by:
    
    removeFinishListener in interface BaseDownloadTask
    
    Parameters:
    
    finishListener - The finish listener.
    
    Returns:
    
    true if remove the finishListener successfully. false otherwise.
  - setAutoRetryTimes
```
public BaseDownloadTask setAutoRetryTimes(int autoRetryTimes)
```
    Description copied from interface: BaseDownloadTask
    
    Set the number of times to retry when encounter any error, except FileDownloadGiveUpRetryException.
    
    Specified by:
    
    setAutoRetryTimes in interface BaseDownloadTask
    
    Parameters:
    
    autoRetryTimes - The retry times, default 0.
  - addHeader
```
public BaseDownloadTask addHeader(String name,
                                  String value)
```
    Description copied from interface: BaseDownloadTask
    
    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.
    
    Specified by:
    
    addHeader in interface BaseDownloadTask
  - addHeader
```
public BaseDownloadTask addHeader(String line)
```
    Description copied from interface: BaseDownloadTask
    
    Add a field with the specified value to the request header.
    
    Specified by:
    
    addHeader in interface BaseDownloadTask
  - removeAllHeaders
```
public BaseDownloadTask removeAllHeaders(String name)
```
    Description copied from interface: BaseDownloadTask
    
    Remove all fields in the request header.
    
    Specified by:
    
    removeAllHeaders in interface BaseDownloadTask
  - setSyncCallback
```
public BaseDownloadTask setSyncCallback(boolean syncCallback)
```
    Specified by:
    
    setSyncCallback in interface BaseDownloadTask
    
    Parameters:
    
    syncCallback - true FileDownloader will invoke methods of FileDownloadListener directly on the download thread(isn't in the main thread).
  - setWifiRequired
```
public BaseDownloadTask setWifiRequired(boolean isWifiRequired)
```
    Description copied from interface: BaseDownloadTask
    
    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.
    
    Specified by:
    
    setWifiRequired in interface BaseDownloadTask
    
    Parameters:
    
    isWifiRequired - true This task only allow to download on the wifi network type.
  - ready
```
public int ready()
```
    Description copied from interface: BaseDownloadTask
    
    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 BaseDownloadTask.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 BaseDownloadTask.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 BaseDownloadTask.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 BaseDownloadTask.reuse() : 1. you invoke BaseDownloadTask.start() manually; 2. the queue start this task automatically.
    
    Specified by:
    
    ready in interface BaseDownloadTask
    
    Returns:
    
    downloadId the download identify.
    
    See Also:
    
    FileDownloader.start(FileDownloadListener, boolean)
  - asInQueueTask
```
public BaseDownloadTask.InQueueTask asInQueueTask()
```
    Description copied from interface: BaseDownloadTask
    
    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.
    
    Specified by:
    
    asInQueueTask in interface BaseDownloadTask
    
    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
```
public boolean reuse()
```
    Description copied from interface: BaseDownloadTask
    
    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.
    
    Specified by:
    
    reuse in interface BaseDownloadTask
    
    Returns:
    
    true if reuse this task successfully. false otherwise.
  - isUsing
```
public boolean isUsing()
```
    Specified by:
    
    isUsing in interface BaseDownloadTask
    
    Returns:
    
    true if the this task already has downloading data, it means that this task is running or has ran.
    
    See Also:
    
    BaseDownloadTask.isRunning(), BaseDownloadTask.start(), BaseDownloadTask.reuse()
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface BaseDownloadTask
    
    Returns:
    
    true if this task is running, in this case, this task isn't allow to BaseDownloadTask.start() again for this task object, and even not allow to BaseDownloadTask.reuse(). false this task maybe BaseDownloadTask.isUsing() or in idle.
    
    See Also:
    
    BaseDownloadTask.isUsing(), BaseDownloadTask.start()
  - isAttached
```
public boolean isAttached()
```
    Description copied from interface: BaseDownloadTask
    
    Whether this task has already attached to a listener / a serial-queue.
    
    Specified by:
    
    isAttached in interface BaseDownloadTask
    
    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
```
public int start()
```
    Description copied from interface: BaseDownloadTask
    
    Start this task in parallel.
    
    Specified by:
    
    start in interface BaseDownloadTask
    
    Returns:
    
    The download id.
  - pause
```
public boolean pause()
```
    Description copied from interface: BaseDownloadTask
    
    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.
    
    Specified by:
    
    pause in interface BaseDownloadTask
    
    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
```
public boolean cancel()
```
    Description copied from interface: BaseDownloadTask
    
    The BaseDownloadTask.pause() also clear all data relate with this task in the memory, so please use BaseDownloadTask.pause() instead.
    
    Specified by:
    
    cancel in interface BaseDownloadTask
    
    Returns:
    
    true if cancel this task successfully.
  - getId
```
public int getId()
```
    Description copied from interface: BaseDownloadTask
    
    The downloading identify of this task, what is generated by BaseDownloadTask.getUrl() and BaseDownloadTask.getPath() and BaseDownloadTask.isPathAsDirectory() from FileDownloadUtils.generateId(String, String).
    
    Specified by:
    
    getId in interface BaseDownloadTask
    
    Returns:
    
    The downloading identify of this task.
    
    See Also:
    
    FileDownloader.pause(int), FileDownloader.getStatus(String, String), FileDownloader.getTotal(int), FileDownloader.getSoFar(int)
  - getDownloadId
```
public int getDownloadId()
```
    Deprecated. Used getId() instead.
    
    Specified by:
    
    getDownloadId in interface BaseDownloadTask
    
    Returns:
    
    The downloading identify of this task.
  - getUrl
```
public String getUrl()
```
    Specified by:
    
    getUrl in interface BaseDownloadTask
    
    Returns:
    
    The Url.
  - getCallbackProgressTimes
```
public int getCallbackProgressTimes()
```
    Specified by:
    
    getCallbackProgressTimes in interface BaseDownloadTask
    
    Returns:
    
    The maximum callback count of FileDownloadListener.progress(BaseDownloadTask, int, int) during the entire process of downloading.
  - getCallbackProgressMinInterval
```
public int getCallbackProgressMinInterval()
```
    Specified by:
    
    getCallbackProgressMinInterval in interface BaseDownloadTask
    
    Returns:
    
    The minimum time interval between each callback of FileDownloadListener.progress(BaseDownloadTask, int, int) .
  - getPath
```
public String getPath()
```
    Specified by:
    
    getPath in interface BaseDownloadTask
    
    Returns:
    
    If BaseDownloadTask.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
```
public boolean isPathAsDirectory()
```
    Specified by:
    
    isPathAsDirectory in interface BaseDownloadTask
    
    Returns:
    
    Whether the result of BaseDownloadTask.getPath() is a directory.
    
    See Also:
    
    BaseDownloadTask.getPath()
  - getFilename
```
public String getFilename()
```
    Specified by:
    
    getFilename in interface BaseDownloadTask
    
    Returns:
    
    If BaseDownloadTask.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 BaseDownloadTask.isPathAsDirectory() is false, the filename will be found immediately when you invoke BaseDownloadTask.setPath(String, boolean) .
  - getTargetFilePath
```
public String getTargetFilePath()
```
    Specified by:
    
    getTargetFilePath in interface BaseDownloadTask
    
    Returns:
    
    The target file path to store the file.
  - getListener
```
public FileDownloadListener getListener()
```
    Specified by:
    
    getListener in interface BaseDownloadTask
    
    Returns:
    
    the downloading listener.
  - getSoFarBytes
```
public int getSoFarBytes()
```
    Specified by:
    
    getSoFarBytes in interface BaseDownloadTask
    
    Returns:
    
    The has already downloaded bytes so far.
  - getSmallFileSoFarBytes
```
public int getSmallFileSoFarBytes()
```
    Description copied from interface: BaseDownloadTask
    
    This method will be used when the length of target file is less than or equal to 1.99G.
    
    Specified by:
    
    getSmallFileSoFarBytes in interface BaseDownloadTask
    
    Returns:
    
    The has already downloaded bytes so far.
  - getLargeFileSoFarBytes
```
public long getLargeFileSoFarBytes()
```
    Description copied from interface: BaseDownloadTask
    
    This method will be used when the length of target file is more than 1.99G.
    
    Specified by:
    
    getLargeFileSoFarBytes in interface BaseDownloadTask
    
    Returns:
    
    The has already downloaded bytes so far.
  - getTotalBytes
```
public int getTotalBytes()
```
    Specified by:
    
    getTotalBytes in interface BaseDownloadTask
    
    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
```
public int getSmallFileTotalBytes()
```
    Description copied from interface: BaseDownloadTask
    
    This method will be used when the length of target file is less than or equal to 1.99G.
    
    Specified by:
    
    getSmallFileTotalBytes in interface BaseDownloadTask
    
    Returns:
    
    The total bytes of the target file.
  - getLargeFileTotalBytes
```
public long getLargeFileTotalBytes()
```
    Description copied from interface: BaseDownloadTask
    
    This method will be used when the length of target file is more than 1.99G.
    
    Specified by:
    
    getLargeFileTotalBytes in interface BaseDownloadTask
    
    Returns:
    
    The total bytes of the target file.
  - getSpeed
```
public int getSpeed()
```
    Description copied from interface: BaseDownloadTask
    
    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 BaseDownloadTask.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).
    
    Specified by:
    
    getSpeed in interface BaseDownloadTask
    
    Returns:
    
    The downloading speed, Unit: KB/s.
    
    See Also:
    
    BaseDownloadTask.setMinIntervalUpdateSpeed(int)
  - getStatus
```
public byte getStatus()
```
    Specified by:
    
    getStatus in interface BaseDownloadTask
    
    Returns:
    
    The downloading status.
    
    See Also:
    
    FileDownloadStatus
  - isForceReDownload
```
public boolean isForceReDownload()
```
    Specified by:
    
    isForceReDownload in interface BaseDownloadTask
    
    Returns:
    
    true if this task force re-download regard less the target file has already exist.
  - getEx
```
public Throwable getEx()
```
    Specified by:
    
    getEx in interface BaseDownloadTask
  - getErrorCause
```
public Throwable getErrorCause()
```
    Specified by:
    
    getErrorCause in interface BaseDownloadTask
    
    Returns:
    
    The error cause.
  - isReusedOldFile
```
public boolean isReusedOldFile()
```
    Specified by:
    
    isReusedOldFile in interface BaseDownloadTask
    
    Returns:
    
    true if this task didn't start downloading really, because the target file has already exist. false otherwise.
    
    See Also:
    
    BaseDownloadTask.isForceReDownload()
  - getTag
```
public Object getTag()
```
    Specified by:
    
    getTag in interface BaseDownloadTask
    
    Returns:
    
    The tag.
  - getTag
```
public Object getTag(int key)
```
    Description copied from interface: BaseDownloadTask
    
    Returns the tag associated with this task and the specified key.
    
    Specified by:
    
    getTag in interface BaseDownloadTask
    
    Parameters:
    
    key - The key identifying the tag.
    
    Returns:
    
    the object stored in this take as a tag, or null if not set.
    
    See Also:
    
    BaseDownloadTask.setTag(int, Object), BaseDownloadTask.getTag()
  - isContinue
```
public boolean isContinue()
```
    Deprecated. Use isResuming() instead.
    
    Specified by:
    
    isContinue in interface BaseDownloadTask
  - isResuming
```
public boolean isResuming()
```
    Specified by:
    
    isResuming in interface BaseDownloadTask
    
    Returns:
    
    true if this task is resuming from the breakpoint, this value is valid after FileDownloadListener.connected(BaseDownloadTask, String, boolean, int, int).
  - getEtag
```
public String getEtag()
```
    Specified by:
    
    getEtag in interface BaseDownloadTask
    
    Returns:
    
    The ETag from the response's header, this value is valid after FileDownloadListener.connected(BaseDownloadTask, String, boolean, int, int)
  - getAutoRetryTimes
```
public int getAutoRetryTimes()
```
    Specified by:
    
    getAutoRetryTimes in interface BaseDownloadTask
    
    Returns:
    
    The number of times has set to retry when occur any error.
    
    See Also:
    
    BaseDownloadTask.setAutoRetryTimes(int)
  - getRetryingTimes
```
public int getRetryingTimes()
```
    Specified by:
    
    getRetryingTimes in interface BaseDownloadTask
    
    Returns:
    
    The currently number of times of retry.this value is valid after FileDownloadListener.retry(BaseDownloadTask, Throwable, int, int)
  - isSyncCallback
```
public boolean isSyncCallback()
```
    Specified by:
    
    isSyncCallback in interface BaseDownloadTask
    
    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:
    
    BaseDownloadTask.setSyncCallback(boolean)
  - isLargeFile
```
public boolean isLargeFile()
```
    Specified by:
    
    isLargeFile in interface BaseDownloadTask
    
    Returns:
    
    true if the length of target file is more than or equal to 2G.
    
    See Also:
    
    BaseDownloadTask.getLargeFileSoFarBytes(), BaseDownloadTask.getLargeFileTotalBytes()
  - isWifiRequired
```
public boolean isWifiRequired()
```
    Specified by:
    
    isWifiRequired in interface BaseDownloadTask
    
    Returns:
    
    true if this task has been set only allows downloading on the wifi network type.
  - getHeader
```
public FileDownloadHeader getHeader()
```
  - markAdded2List
```
public void markAdded2List()
```
    Description copied from interface: BaseDownloadTask.IRunningTask
    
    Mark the task has already added to the downloading list.
    
    Specified by:
    
    markAdded2List in interface BaseDownloadTask.IRunningTask
  - free
```
public void free()
```
    Description copied from interface: BaseDownloadTask.IRunningTask
    
    Free the task.
    
    Specified by:
    
    free in interface BaseDownloadTask.IRunningTask
  - startTaskByQueue
```
public void startTaskByQueue()
```
    Description copied from interface: BaseDownloadTask.IRunningTask
    
    Start the task by the queue handler.
    
    Specified by:
    
    startTaskByQueue in interface BaseDownloadTask.IRunningTask
  - startTaskByRescue
```
public void startTaskByRescue()
```
    Description copied from interface: BaseDownloadTask.IRunningTask
    
    Start the task just because this task can't started by pass, and now, we try to rescue this task and start it.
    Currently, this rescue is occurred when the filedownloader service connected.
    
    Specified by:
    
    startTaskByRescue in interface BaseDownloadTask.IRunningTask
  - getPauseLock
```
public Object getPauseLock()
```
    Description copied from interface: BaseDownloadTask.IRunningTask
    
    Get the object as a lock for synchronized with the pause area.
    
    Specified by:
    
    getPauseLock in interface BaseDownloadTask.IRunningTask
    
    Returns:
    
    the object as a lock for synchronized with the pause area.
  - isContainFinishListener
```
public boolean isContainFinishListener()
```
    Description copied from interface: BaseDownloadTask.IRunningTask
    
    Whether contain finish listener or not.
    
    Specified by:
    
    isContainFinishListener in interface BaseDownloadTask.IRunningTask
    
    Returns:
    
    true if there is finish listener on the task.
  - isMarkedAdded2List
```
public boolean isMarkedAdded2List()
```
    Specified by:
    
    isMarkedAdded2List in interface BaseDownloadTask.IRunningTask
    
    Returns:
    
    true the task has already added to the downloading list.
  - getRunningTask
```
public BaseDownloadTask.IRunningTask getRunningTask()
```
  - setFileName
```
public void setFileName(String fileName)
```
  - getFinishListenerList
```
public ArrayList<BaseDownloadTask.FinishListener> getFinishListenerList()
```
  - getOrigin
```
public BaseDownloadTask getOrigin()
```
    Specified by:
    
    getOrigin in interface BaseDownloadTask.IRunningTask
    
    Returns:
    
    The origin one.
  - getMessageHandler
```
public ITaskHunter.IMessageHandler getMessageHandler()
```
    Specified by:
    
    getMessageHandler in interface BaseDownloadTask.IRunningTask
    
    Returns:
    
    The message handler of this task.
  - is
```
public boolean is(int id)
```
    Specified by:
    
    is in interface BaseDownloadTask.IRunningTask
    
    Returns:
    
    true the id of the task is equal to the id.
  - is
```
public boolean is(FileDownloadListener listener)
```
    Specified by:
    
    is in interface BaseDownloadTask.IRunningTask
    
    Returns:
    
    true the listener of the task is equal to the listener.
  - isOver
```
public boolean isOver()
```
    Specified by:
    
    isOver in interface BaseDownloadTask.IRunningTask
    
    Returns:
    
    true if the task has already finished.
  - getAttachKey
```
public int getAttachKey()
```
    Description copied from interface: BaseDownloadTask.IRunningTask
    
    When the task is running, it must attach a key. if this task is running in a queue downloading tasks serial, the attach key is equal to the hash code of the callback of queue's handler, otherwise the attach key is equal to the hash code of the listener.
    
    Specified by:
    
    getAttachKey in interface BaseDownloadTask.IRunningTask
    
    Returns:
    
    The attached key, if this task in a queue, the attached key is the hash code of the listener.
  - setAttachKeyByQueue
```
public void setAttachKeyByQueue(int key)
```
    Description copied from interface: BaseDownloadTask.IRunningTask
    
    Set this task attach to the key by the queue. In this case, this task must be a task which belong to a queue, and will be started automatically by the queue.
    
    Specified by:
    
    setAttachKeyByQueue in interface BaseDownloadTask.IRunningTask
    
    Parameters:
    
    key - The attached key for this task.
  - setAttachKeyDefault
```
public void setAttachKeyDefault()
```
    Description copied from interface: BaseDownloadTask.IRunningTask
    
    Set this task to the default key. In this case, this task must be a task which is a isolated task.
    
    Specified by:
    
    setAttachKeyDefault in interface BaseDownloadTask.IRunningTask
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DownloadTask

Nested Class Summary

Nested classes/interfaces inherited from interface com.liulishuo.filedownloader.BaseDownloadTask

Field Summary

Method Summary

Methods inherited from class java.lang.Object

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

getHeader

markAdded2List

free

startTaskByQueue

startTaskByRescue

getPauseLock

isContainFinishListener

isMarkedAdded2List

getRunningTask

setFileName

getFinishListenerList