com.liulishuo.filedownloader.database

Interface FileDownloadDatabase

All Known Implementing Classes:

NoDatabaseImpl, RemitDatabase, SqliteDatabaseImpl

public interface FileDownloadDatabase

The filedownloader database, what is used for storing the FileDownloadModel.

The data stored in the database is only used for task resumes from the breakpoint.

The task of the data stored in the database must be a task that has not finished downloading yet, and if the task has finished downloading, its data will be remove(int) from the database, since that data is no longer available for resumption of its task pass.

See Also:

SqliteDatabaseImpl, FileDownloadUtils.isBreakpointAvailable(int, FileDownloadModel)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FileDownloadDatabase.Maintainer the maintainer for the database, this maintainer will be used when the database is initializing.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all models in this database.
FileDownloadModel	find(int id) Find the model which identify is id.
java.util.List<ConnectionModel>	findConnectionModel(int id) Find the connection model which download identify is id
void	insert(FileDownloadModel downloadModel) Insert the model to the database.
void	insertConnectionModel(ConnectionModel model) Insert the model to connection table.
FileDownloadDatabase.Maintainer	maintainer() Get the maintainer for the database, this maintainer will be used when the database is initializing.
void	onTaskStart(int id) Invoked when task is started.
boolean	remove(int id) Remove the model which identify is id.
void	removeConnections(int id) Delete all connection model store on database through the download id.
void	update(FileDownloadModel downloadModel) Update the data compare to the downloadModel
void	updateCompleted(int id, long total) Update the data because of the download status alternative to FileDownloadStatus.completed.
void	updateConnected(int id, long total, java.lang.String etag, java.lang.String filename) Update the data because of the download status alternative to FileDownloadStatus.connected.
void	updateConnectionCount(int id, int count) Update the count of connection.
void	updateConnectionModel(int id, int index, long currentOffset) Update the currentOffset with currentOffset which id is id, index is index
void	updateError(int id, java.lang.Throwable throwable, long sofar) Update the data because of the download status alternative to FileDownloadStatus.error.
void	updateOldEtagOverdue(int id, java.lang.String newEtag, long sofar, long total, int connectionCount) Update when the old one is overdue.
void	updatePause(int id, long sofar) Update the data because of the download status alternative to FileDownloadStatus.paused.
void	updatePending(int id) Update the data because of the download status alternative to FileDownloadStatus.pending.
void	updateProgress(int id, long sofarBytes) Update the sofar bytes with the status progress, so don't forget to store the FileDownloadStatus.progress too.
void	updateRetry(int id, java.lang.Throwable throwable) Update the data because of the download status alternative to FileDownloadStatus.retry.

Method Detail

onTaskStart

void onTaskStart(int id)

Invoked when task is started.

Parameters:

id - the download id.

find

FileDownloadModel find(int id)

Find the model which identify is id.

Parameters:

id - the download id.

findConnectionModel

java.util.List<ConnectionModel> findConnectionModel(int id)

Find the connection model which download identify is id

Parameters:

id - the download id.

removeConnections

void removeConnections(int id)

Delete all connection model store on database through the download id.

Parameters:

id - the download id.

insertConnectionModel

void insertConnectionModel(ConnectionModel model)

Insert the model to connection table.

Parameters:

model - the connection model.

updateConnectionModel

void updateConnectionModel(int id,
                           int index,
                           long currentOffset)

Update the currentOffset with currentOffset which id is id, index is index

Parameters:

id - the download id.

index - the connection index.

currentOffset - the current offset.

updateConnectionCount

void updateConnectionCount(int id,
                           int count)

Update the count of connection.

Parameters:

count - the connection count.

insert

void insert(FileDownloadModel downloadModel)

Insert the model to the database.

Parameters:

downloadModel - the download model.

update

void update(FileDownloadModel downloadModel)

Update the data compare to the downloadModel

Parameters:

downloadModel - the download model.

remove

boolean remove(int id)

Remove the model which identify is id.

Parameters:

id - the download id.

Returns:

true if succeed to remove model from the database.

clear

void clear()

Clear all models in this database.

updateOldEtagOverdue

void updateOldEtagOverdue(int id,
                          java.lang.String newEtag,
                          long sofar,
                          long total,
                          int connectionCount)

Update when the old one is overdue.

updateConnected

void updateConnected(int id,
                     long total,
                     java.lang.String etag,
                     java.lang.String filename)

Update the data because of the download status alternative to FileDownloadStatus.connected.

Parameters:

id - the download id.

total - the new total bytes.

etag - the new etag. this value will be null when we can't find it on response header.

filename - the new file name. this value will be null when its no need to store.

updateProgress

void updateProgress(int id,
                    long sofarBytes)

Update the sofar bytes with the status progress, so don't forget to store the FileDownloadStatus.progress too.

Parameters:

sofarBytes - the current sofar bytes.

updateError

void updateError(int id,
                 java.lang.Throwable throwable,
                 long sofar)

Update the data because of the download status alternative to FileDownloadStatus.error.

Parameters:

id - the download id.

throwable - the new exception.

sofar - the new so far bytes.

updateRetry

void updateRetry(int id,
                 java.lang.Throwable throwable)

Update the data because of the download status alternative to FileDownloadStatus.retry.

Parameters:

id - the download id.

throwable - the new exception.

updateCompleted

void updateCompleted(int id,
                     long total)

Update the data because of the download status alternative to FileDownloadStatus.completed. The latest version will remove model from DB.

Parameters:

id - the download id.

total - the new total bytes.

updatePause

void updatePause(int id,
                 long sofar)

Update the data because of the download status alternative to FileDownloadStatus.paused.

Parameters:

id - the download id.

sofar - the new so far bytes.

updatePending

void updatePending(int id)

Update the data because of the download status alternative to FileDownloadStatus.pending.

Parameters:

id - the download id.

maintainer

FileDownloadDatabase.Maintainer maintainer()

Get the maintainer for the database, this maintainer will be used when the database is initializing.

The maintainer will return all data on the database.

Demo: SqliteDatabaseImpl.Maintainer

Returns:

the maintainer for maintain the database.