com.liulishuo.filedownloader

Class FileDownloader

java.lang.Object

com.liulishuo.filedownloader.FileDownloader

public class FileDownloader
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FileDownloader()

Method Summary

Modifier and Type	Method and Description
void	addServiceConnectListener(FileDownloadConnectListener connectListener) Deprecated.
void	bindService() Deprecated.
void	bindService(java.lang.Runnable runnable) Deprecated.
boolean	clear(int id, java.lang.String targetFilePath) Clear the data with the provided id.
void	clearAllTaskData() Deprecated.
DownloadTaskAdapter	create(java.lang.String url)
static void	disableAvoidDropFrame() Disable avoiding missing screen frames, let all callbacks in FileDownloadListener can be invoked at once when it achieve.
void	discardFileDownloadDatabase(android.content.Context context) Because the FileDownloader database cannot be compatible with OkDownload database, provide this method to discard the database of FileDownloader.
static void	enableAvoidDropFrame() Avoid missing screen frames, this leads to all callbacks in FileDownloadListener do not be invoked at once when it has already achieved to ensure callbacks don't be too frequent
static FileDownloader	getImpl()
long	getSoFar(int downloadId) Get downloaded bytes so far by the downloadId.
byte	getStatus(int id, java.lang.String path) Deprecated.
byte	getStatus(java.lang.String url, java.lang.String path)
byte	getStatusIgnoreCompleted(int id) Deprecated.
long	getTotal(int id) Get the total bytes of the target file for the task with the {code id}.
static void	init(android.content.Context context)
static void	init(android.content.Context context, FileDownloadHelper.OkHttpClientCustomMaker okHttpClientCustomMaker)
static void	init(android.content.Context context, FileDownloadHelper.OkHttpClientCustomMaker okHttpClientCustomMaker, int maxNetworkThreadCount) Initial a OkDownload instance.
FileDownloadLine	insureServiceBind() Because there is no any service, the FileDownloadLine will not do any wait action.
FileDownloadLineAsync	insureServiceBindAsync() Deprecated.
static boolean	isEnabledAvoidDropFrame()
boolean	isServiceConnected() Deprecated.
static com.liulishuo.okdownload.OkDownload.Builder	okDownloadBuilder(android.content.Context context, FileDownloadHelper.OkHttpClientCustomMaker okHttpClientCustomMaker)
void	pause(FileDownloadListener listener)
int	pause(int id)
void	pauseAll()
void	removeServiceConnectListener(FileDownloadConnectListener connectListener) Deprecated.
int	replaceListener(int id, FileDownloadListener listener) Find the running task by id, and replace its listener width the new one listener.
int	replaceListener(java.lang.String url, FileDownloadListener listener) Find the running task by url and default path, and replace its listener with the new one listener.
int	replaceListener(java.lang.String url, java.lang.String path, FileDownloadListener listener) Find the running task by url and path, and replace its listener with the new one listener.
static void	setGlobalHandleSubPackageSize(int packageSize) Deprecated.
static void	setGlobalPost2UIInterval(int intervalMillisecond) For avoiding missing screen frames.
boolean	setMaxNetworkThreadCount(int count) Deprecated.
static void	setup(android.content.Context context) You can invoke this method anytime before you using the FileDownloader.
static DownloadMgrInitialParams.InitCustomMaker	setupOnApplicationOnCreate(android.app.Application application) Using this method to setup the FileDownloader only you want to register your own customize components for Filedownloader, otherwise just using setup(Context) instead.
boolean	start(FileDownloadListener listener, boolean isSerial) Start the download queue by the same listener.
void	startForeground(int id, android.app.Notification notification) Deprecated.
void	stopForeground(boolean removeNotification) Deprecated.
void	unbindService() Deprecated.
void	unBindServiceIfIdle() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileDownloader

public FileDownloader()

Method Detail

getImpl

public static FileDownloader getImpl()

init

public static void init(@NonNull
                        android.content.Context context)

init

public static void init(@NonNull
                        android.content.Context context,
                        @Nullable
                        FileDownloadHelper.OkHttpClientCustomMaker okHttpClientCustomMaker)

init

public static void init(@NonNull
                        android.content.Context context,
                        @Nullable
                        FileDownloadHelper.OkHttpClientCustomMaker okHttpClientCustomMaker,
                        int maxNetworkThreadCount)

Initial a OkDownload instance. This method and setupOnApplicationOnCreate(Application) cannot be invoked int the same time.

Parameters:

context - Android context.

okHttpClientCustomMaker - a maker to build a OkHttpClient.

maxNetworkThreadCount - the max thread count of thread pool for downloading. This parameter is deprecated in OkDownload.

okDownloadBuilder

@Nullable
public static com.liulishuo.okdownload.OkDownload.Builder okDownloadBuilder(@NonNull
                                                                                      android.content.Context context,
                                                                                      @Nullable
                                                                                      FileDownloadHelper.OkHttpClientCustomMaker okHttpClientCustomMaker)

setup

public static void setup(@NonNull
                         android.content.Context context)

You can invoke this method anytime before you using the FileDownloader.

Parameters:

context - the context of Application or Activity etc..

setupOnApplicationOnCreate

public static DownloadMgrInitialParams.InitCustomMaker setupOnApplicationOnCreate(android.app.Application application)

Using this method to setup the FileDownloader only you want to register your own customize components for Filedownloader, otherwise just using setup(Context) instead.

Please invoke this method on the Application.onCreate() because of the customize components must be assigned before FileDownloader is running.

Such as:

class MyApplication extends Application { ... public void onCreate() { ... FileDownloader.setupOnApplicationOnCreate(this) .idGenerator(new MyIdGenerator()) .database(new MyDatabase()) ... .commit(); ... } ... }

Parameters:

application - the application.

Returns:

the customize components maker.

create

public DownloadTaskAdapter create(java.lang.String url)

start

public boolean start(FileDownloadListener listener,
                     boolean isSerial)

Start the download queue by the same listener.

Parameters:

listener - Used to assemble tasks which is bound by the same listener

isSerial - Whether start tasks one by one rather than parallel.

Returns:

true if start tasks successfully.

bindService

@Deprecated
public void bindService()

Deprecated.

unbindService

@Deprecated
public void unbindService()

Deprecated.

unBindServiceIfIdle

@Deprecated
public void unBindServiceIfIdle()

Deprecated.

isServiceConnected

@Deprecated
public boolean isServiceConnected()

Deprecated.

addServiceConnectListener

@Deprecated
public void addServiceConnectListener(FileDownloadConnectListener connectListener)

Deprecated.

removeServiceConnectListener

@Deprecated
public void removeServiceConnectListener(FileDownloadConnectListener connectListener)

Deprecated.

startForeground

@Deprecated
public void startForeground(int id,
                                        android.app.Notification notification)

Deprecated.

stopForeground

@Deprecated
public void stopForeground(boolean removeNotification)

Deprecated.

setMaxNetworkThreadCount

@Deprecated
public boolean setMaxNetworkThreadCount(int count)

Deprecated.

bindService

@Deprecated
public void bindService(java.lang.Runnable runnable)

Deprecated.

No need to bind any service.

pause

public void pause(FileDownloadListener listener)

pauseAll

public void pauseAll()

pause

public int pause(int id)

setGlobalPost2UIInterval

public static void setGlobalPost2UIInterval(int intervalMillisecond)

For avoiding missing screen frames.

This mechanism is used for avoid methods in FileDownloadListener is invoked too frequent in result the system missing screen frames in the main thread.

setGlobalHandleSubPackageSize

@Deprecated
public static void setGlobalHandleSubPackageSize(int packageSize)

Deprecated.

Only use BaseDownloadTask.setCallbackProgressMinInterval(int) in OkDownload.

enableAvoidDropFrame

public static void enableAvoidDropFrame()

Avoid missing screen frames, this leads to all callbacks in FileDownloadListener do not be invoked at once when it has already achieved to ensure callbacks don't be too frequent

disableAvoidDropFrame

public static void disableAvoidDropFrame()

Disable avoiding missing screen frames, let all callbacks in FileDownloadListener can be invoked at once when it achieve.

isEnabledAvoidDropFrame

public static boolean isEnabledAvoidDropFrame()

Returns:

true if enabled the function of avoiding missing screen frames.

getSoFar

public long getSoFar(int downloadId)

Get downloaded bytes so far by the downloadId.

getTotal

public long getTotal(int id)

Get the total bytes of the target file for the task with the {code id}.

clearAllTaskData

@Deprecated
public void clearAllTaskData()

Deprecated.

Clear all data in the filedownloader database. BreakpointStore doesn't provide clear all data api, and it's no need to clear database manually in fact.

clear

public boolean clear(int id,
                     java.lang.String targetFilePath)

Clear the data with the provided id. Normally used to deleting the data in OkDownload database, when it is paused or in downloading status. If you want to re-download it clearly.

Note: YOU NO NEED to clear the data when it is already completed downloading because the data would be deleted when it completed downloading automatically by OkDownload.

getStatusIgnoreCompleted

@Deprecated
public byte getStatusIgnoreCompleted(int id)

Deprecated.

Task id will change in OkDownload, so cannot use id to get status. Please use getStatus(String, String)

Returns:

The downloading status without cover the completed status (if completed you will receive FileDownloadStatus.INVALID_STATUS ).

getStatus

public byte getStatus(java.lang.String url,
                      java.lang.String path)

Parameters:

url - The downloading URL.

path - The downloading file's path.

Returns:

The downloading status.

See Also:

getStatus(int, String), getStatusIgnoreCompleted(int)

getStatus

@Deprecated
public byte getStatus(int id,
                                  java.lang.String path)

Deprecated.

Task id will change in OkDownload, so cannot use id to get status. Please use getStatus(String, String)

replaceListener

public int replaceListener(java.lang.String url,
                           FileDownloadListener listener)

Find the running task by url and default path, and replace its listener with the new one listener.

Returns:

The target task's DownloadId, if not exist target task, and replace failed, will be 0

See Also:

replaceListener(int, FileDownloadListener), replaceListener(String, String, FileDownloadListener)

replaceListener

public int replaceListener(java.lang.String url,
                           java.lang.String path,
                           FileDownloadListener listener)

Find the running task by url and path, and replace its listener with the new one listener.

Returns:

The target task's DownloadId, if not exist target task, and replace failed, will be 0

See Also:

replaceListener(String, FileDownloadListener), replaceListener(int, FileDownloadListener)

replaceListener

public int replaceListener(int id,
                           FileDownloadListener listener)

Find the running task by id, and replace its listener width the new one listener.

Returns:

The target task's DownloadId, if not exist target task, and replace failed, will be 0

See Also:

replaceListener(String, FileDownloadListener), replaceListener(String, String, FileDownloadListener)

insureServiceBind

public FileDownloadLine insureServiceBind()

Because there is no any service, the FileDownloadLine will not do any wait action.

See Also:

FileDownloadLine, bindService(Runnable)

insureServiceBindAsync

@Deprecated
public FileDownloadLineAsync insureServiceBindAsync()

Deprecated.

discardFileDownloadDatabase

public void discardFileDownloadDatabase(android.content.Context context)

Because the FileDownloader database cannot be compatible with OkDownload database, provide this method to discard the database of FileDownloader. It's better to invoke this method at work thread.