com.liulishuo.filedownloader.message

Class MessageSnapshot

java.lang.Object

com.liulishuo.filedownloader.message.MessageSnapshot

All Implemented Interfaces:

Parcelable

Direct Known Subclasses:

BlockCompleteMessage.BlockCompleteMessageImpl, LargeMessageSnapshot, MessageSnapshot.StartedMessageSnapshot, SmallMessageSnapshot

public abstract class MessageSnapshot
extends Object
implements Parcelable

The message snapshot.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MessageSnapshot.IWarnMessageSnapshot
static class	MessageSnapshot.NoFieldException
static class	MessageSnapshot.StartedMessageSnapshot

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<MessageSnapshot>	CREATOR
protected boolean	isLargeFile

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	describeContents()
String	getEtag()
String	getFileName()
int	getId()
long	getLargeSofarBytes() This method will be used when the downloading file is a large file.
long	getLargeTotalBytes() This method will be used when the downloading file is a large file.
int	getRetryingTimes()
int	getSmallSofarBytes() This method will be used when the downloading file isn't a large file.
int	getSmallTotalBytes() This method will be used when the downloading file isn't a large file.
byte	getStatus()
Throwable	getThrowable()
boolean	isLargeFile()
boolean	isResuming()
boolean	isReusedDownloadedFile()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

isLargeFile

protected boolean isLargeFile

CREATOR

public static final Parcelable.Creator<MessageSnapshot> CREATOR

Method Detail

getId

public int getId()

Returns:

The download identify.

getThrowable

public Throwable getThrowable()

Returns:

The error cause.

getRetryingTimes

public int getRetryingTimes()

Returns:

The currently retrying times.

isResuming

public boolean isResuming()

Returns:

true if the downloading is resuming from the breakpoint, otherwise the downloading is from the beginning.

getEtag

public String getEtag()

Returns:

the Etag from the response's header.

getLargeSofarBytes

public long getLargeSofarBytes()

This method will be used when the downloading file is a large file.

Returns:

The so far downloaded bytes.

See Also:

isLargeFile()

getLargeTotalBytes

public long getLargeTotalBytes()

This method will be used when the downloading file is a large file.

Returns:

The total bytes of the downloading file.

See Also:

isLargeFile()

getSmallSofarBytes

public int getSmallSofarBytes()

This method will be used when the downloading file isn't a large file.

Returns:

The so far downloaded bytes.

See Also:

isLargeFile()

getSmallTotalBytes

public int getSmallTotalBytes()

This method will be used when the downloading file isn't a large file.

Returns:

The total bytes of the downloading file.

See Also:

isLargeFile()

isReusedDownloadedFile

public boolean isReusedDownloadedFile()

Returns:

true if the task isn't real started, and we find the target file is already exist, so the task will receive the completed callback directly, false otherwise.

getFileName

public String getFileName()

Returns:

The filename.

isLargeFile

public boolean isLargeFile()

Returns:

true if the length of the file is more than 1.99G, false otherwise.

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

getStatus

public byte getStatus()

Returns:

The current downloading status.

See Also:

FileDownloadStatus