com.liulishuo.filedownloader.model

Class FileDownloadModel

java.lang.Object

com.liulishuo.filedownloader.model.FileDownloadModel

All Implemented Interfaces:

android.os.Parcelable

public class FileDownloadModel
extends java.lang.Object
implements android.os.Parcelable

The model of the downloading task will be used in the filedownloader database.

See Also:

FileDownloadDatabase

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONNECTION_COUNT
static android.os.Parcelable.Creator<FileDownloadModel>	CREATOR
static int	DEFAULT_CALLBACK_PROGRESS_TIMES
static java.lang.String	ERR_MSG
static java.lang.String	ETAG
static java.lang.String	FILENAME
static java.lang.String	ID
static java.lang.String	PATH
static java.lang.String	PATH_AS_DIRECTORY
static java.lang.String	SOFAR
static java.lang.String	STATUS
static java.lang.String	TOTAL
static int	TOTAL_VALUE_IN_CHUNKED_RESOURCE
static java.lang.String	URL

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	FileDownloadModel()
protected	FileDownloadModel(android.os.Parcel in)

Method Summary

Modifier and Type	Method and Description
void	deleteTargetFile()
void	deleteTaskFiles()
void	deleteTempFile()
int	describeContents()
int	getConnectionCount()
java.lang.String	getErrMsg()
java.lang.String	getETag()
java.lang.String	getFilename()
int	getId()
java.lang.String	getPath() Get the path user set from BaseDownloadTask.setPath(String)
long	getSoFar()
byte	getStatus()
java.lang.String	getTargetFilePath() Get the finally target file path is used for store the download file.
java.lang.String	getTempFilePath()
long	getTotal()
java.lang.String	getUrl()
void	increaseSoFar(long increaseBytes)
boolean	isChunked()
boolean	isLargeFile()
boolean	isPathAsDirectory()
void	resetConnectionCount() reset the connection count to default value: 1.
void	setConnectionCount(int connectionCount)
void	setErrMsg(java.lang.String errMsg)
void	setETag(java.lang.String eTag)
void	setFilename(java.lang.String filename)
void	setId(int id)
void	setPath(java.lang.String path, boolean pathAsDirectory)
void	setSoFar(long soFar)
void	setStatus(byte status)
void	setTotal(long total)
void	setUrl(java.lang.String url)
android.content.ContentValues	toContentValues()
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

TOTAL_VALUE_IN_CHUNKED_RESOURCE

public static final int TOTAL_VALUE_IN_CHUNKED_RESOURCE

See Also:

Constant Field Values

DEFAULT_CALLBACK_PROGRESS_TIMES

public static final int DEFAULT_CALLBACK_PROGRESS_TIMES

See Also:

Constant Field Values

ID

public static final java.lang.String ID

See Also:

Constant Field Values

URL

public static final java.lang.String URL

See Also:

Constant Field Values

PATH

public static final java.lang.String PATH

See Also:

Constant Field Values

PATH_AS_DIRECTORY

public static final java.lang.String PATH_AS_DIRECTORY

See Also:

Constant Field Values

FILENAME

public static final java.lang.String FILENAME

See Also:

Constant Field Values

STATUS

public static final java.lang.String STATUS

See Also:

Constant Field Values

SOFAR

public static final java.lang.String SOFAR

See Also:

Constant Field Values

TOTAL

public static final java.lang.String TOTAL

See Also:

Constant Field Values

ERR_MSG

public static final java.lang.String ERR_MSG

See Also:

Constant Field Values

ETAG

public static final java.lang.String ETAG

See Also:

Constant Field Values

CONNECTION_COUNT

public static final java.lang.String CONNECTION_COUNT

See Also:

Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<FileDownloadModel> CREATOR

Constructor Detail

FileDownloadModel

public FileDownloadModel()

FileDownloadModel

protected FileDownloadModel(android.os.Parcel in)

Method Detail

setId

public void setId(int id)

setUrl

public void setUrl(java.lang.String url)

setPath

public void setPath(java.lang.String path,
                    boolean pathAsDirectory)

setStatus

public void setStatus(byte status)

setSoFar

public void setSoFar(long soFar)

increaseSoFar

public void increaseSoFar(long increaseBytes)

setTotal

public void setTotal(long total)

getId

public int getId()

getUrl

public java.lang.String getUrl()

getPath

public java.lang.String getPath()

Get the path user set from BaseDownloadTask.setPath(String)

Returns:

the path user set from BaseDownloadTask.setPath(String)

See Also:

getTargetFilePath()

getTargetFilePath

public java.lang.String getTargetFilePath()

Get the finally target file path is used for store the download file.

This path is composited with path、pathAsDirectory、filename.

Why getPath() may be not equal to getTargetFilePath()? this case only occurred when the isPathAsDirectory() is true, on this scenario the getPath() is directory, and the getTargetFilePath() is 'directory + "/" + filename'.

Returns:

the finally target file path.

getTempFilePath

public java.lang.String getTempFilePath()

getStatus

public byte getStatus()

getSoFar

public long getSoFar()

getTotal

public long getTotal()

isChunked

public boolean isChunked()

getETag

public java.lang.String getETag()

setETag

public void setETag(java.lang.String eTag)

getErrMsg

public java.lang.String getErrMsg()

setErrMsg

public void setErrMsg(java.lang.String errMsg)

setFilename

public void setFilename(java.lang.String filename)

isPathAsDirectory

public boolean isPathAsDirectory()

getFilename

public java.lang.String getFilename()

setConnectionCount

public void setConnectionCount(int connectionCount)

getConnectionCount

public int getConnectionCount()

resetConnectionCount

public void resetConnectionCount()

reset the connection count to default value: 1.

toContentValues

public android.content.ContentValues toContentValues()

isLargeFile

public boolean isLargeFile()

deleteTaskFiles

public void deleteTaskFiles()

deleteTempFile

public void deleteTempFile()

deleteTargetFile

public void deleteTargetFile()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable