com.liulishuo.filedownloader

Class DownloadTaskHunter

java.lang.Object

com.liulishuo.filedownloader.DownloadTaskHunter

All Implemented Interfaces:

BaseDownloadTask.LifeCycleCallback, IDownloadSpeed.Lookup, ITaskHunter, ITaskHunter.IMessageHandler, ITaskHunter.IStarter

public class DownloadTaskHunter
extends Object
implements ITaskHunter, ITaskHunter.IStarter, ITaskHunter.IMessageHandler, BaseDownloadTask.LifeCycleCallback

The download task hunter.

Nested Class Summary

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

ITaskHunter.IMessageHandler, ITaskHunter.IStarter

Method Summary

Modifier and Type	Method and Description
boolean	equalListener(FileDownloadListener listener)
void	free() Free the current hunter.
Throwable	getErrorCause()
String	getEtag()
com.liulishuo.filedownloader.IFileDownloadMessenger	getMessenger()
int	getRetryingTimes()
long	getSofarBytes()
int	getSpeed()
byte	getStatus()
long	getTotalBytes()
void	intoLaunchPool() Enter into the launch pool.
boolean	isLargeFile()
boolean	isResuming()
boolean	isReusedOldFile()
void	onBegin() The task begin working.
void	onIng() The task is running, and during the downloading processing, when the status of the task is changed will trigger to callback this method.
void	onOver() The task is end.
boolean	pause()
MessageSnapshot	prepareErrorMessage(Throwable cause)
void	reset() Reset the hunter.
void	setMinIntervalUpdateSpeed(int minIntervalUpdateSpeed)
void	start() Start the task in the launcher thread.
boolean	updateKeepAhead(MessageSnapshot snapshot) Try to dispatch the snapshot with the keep ahead policy.
boolean	updateKeepFlow(MessageSnapshot snapshot) Try to dispatch the snapshot with the keep right flow policy.
boolean	updateMoreLikelyCompleted(MessageSnapshot snapshot) Try to dispatch the snapshot with the more likely completed policy.
boolean	updateSameFilePathTaskRunning(MessageSnapshot snapshot) Try to dispatch the snapshot with the same file path policy.

Methods inherited from class java.lang.Object

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

Method Detail

updateKeepAhead

public boolean updateKeepAhead(MessageSnapshot snapshot)

Description copied from interface: ITaskHunter.IMessageHandler

Try to dispatch the snapshot with the keep ahead policy.

Specified by:

updateKeepAhead in interface ITaskHunter.IMessageHandler

Parameters:

snapshot - the received message snapshot.

Returns:

true the message has been dispatched successfully.

updateKeepFlow

public boolean updateKeepFlow(MessageSnapshot snapshot)

Description copied from interface: ITaskHunter.IMessageHandler

Try to dispatch the snapshot with the keep right flow policy.

Specified by:

updateKeepFlow in interface ITaskHunter.IMessageHandler

Parameters:

snapshot - the received message snapshot.

Returns:

true the message has been dispatched successfully.

updateMoreLikelyCompleted

public boolean updateMoreLikelyCompleted(MessageSnapshot snapshot)

Description copied from interface: ITaskHunter.IMessageHandler

Try to dispatch the snapshot with the more likely completed policy.

The more likely completed policy: in some case the snapshot more likely to a waiting to complete task.

Specified by:

updateMoreLikelyCompleted in interface ITaskHunter.IMessageHandler

Parameters:

snapshot - the received message snapshot.

Returns:

true the message has been dispatched successfully.

updateSameFilePathTaskRunning

public boolean updateSameFilePathTaskRunning(MessageSnapshot snapshot)

Description copied from interface: ITaskHunter.IMessageHandler

Try to dispatch the snapshot with the same file path policy.

The same file path policy: when the path provided by the user is a directory, we find the filename until the response from the service has been received, in this case when we find the target file path maybe can equal to another running task, so in this case, this task need callback a warn message.

Specified by:

updateSameFilePathTaskRunning in interface ITaskHunter.IMessageHandler

Parameters:

snapshot - the received message snapshot.

Returns:

true the message has been dispatched successfully.

getMessenger

public com.liulishuo.filedownloader.IFileDownloadMessenger getMessenger()

Specified by:

getMessenger in interface ITaskHunter.IMessageHandler

Returns:

The messenger for the message handler.

prepareErrorMessage

public MessageSnapshot prepareErrorMessage(Throwable cause)

Specified by:

prepareErrorMessage in interface ITaskHunter.IMessageHandler

Parameters:

cause - The cause of occurred exception.

Returns:

This message snapshot capture from the cause.

onBegin

public void onBegin()

Description copied from interface: BaseDownloadTask.LifeCycleCallback

The task begin working.

Specified by:

onBegin in interface BaseDownloadTask.LifeCycleCallback

onIng

public void onIng()

Description copied from interface: BaseDownloadTask.LifeCycleCallback

The task is running, and during the downloading processing, when the status of the task is changed will trigger to callback this method.

Specified by:

onIng in interface BaseDownloadTask.LifeCycleCallback

onOver

public void onOver()

Description copied from interface: BaseDownloadTask.LifeCycleCallback

The task is end.

Specified by:

onOver in interface BaseDownloadTask.LifeCycleCallback

intoLaunchPool

public void intoLaunchPool()

Description copied from interface: ITaskHunter

Enter into the launch pool.

Specified by:

intoLaunchPool in interface ITaskHunter

See Also:

FileDownloadTaskLauncher

pause

public boolean pause()

Specified by:

pause in interface ITaskHunter

Returns:

Whether pause the task successfully.

getStatus

public byte getStatus()

Specified by:

getStatus in interface ITaskHunter

Returns:

the status.

See Also:

FileDownloadStatus

reset

public void reset()

Description copied from interface: ITaskHunter

Reset the hunter.

Specified by:

reset in interface ITaskHunter

setMinIntervalUpdateSpeed

public void setMinIntervalUpdateSpeed(int minIntervalUpdateSpeed)

Specified by:

setMinIntervalUpdateSpeed in interface IDownloadSpeed.Lookup

Parameters:

minIntervalUpdateSpeed - The minimum interval to update the speed, used to adjust the refresh frequent.

getSpeed

public int getSpeed()

Specified by:

getSpeed in interface IDownloadSpeed.Lookup

Returns:

The currently downloading speed when the task is running. The average speed when the task is finished.

getSofarBytes

public long getSofarBytes()

Specified by:

getSofarBytes in interface ITaskHunter

Returns:

The so far downloaded bytes.

getTotalBytes

public long getTotalBytes()

Specified by:

getTotalBytes in interface ITaskHunter

Returns:

The total bytes.

getErrorCause

public Throwable getErrorCause()

Specified by:

getErrorCause in interface ITaskHunter

Returns:

Null if has didn't occurred any error yet.

getRetryingTimes

public int getRetryingTimes()

Specified by:

getRetryingTimes in interface ITaskHunter

Returns:

The currently retrying times.

isReusedOldFile

public boolean isReusedOldFile()

Specified by:

isReusedOldFile in interface ITaskHunter

Returns:

true if didn't real start downloading but the old-file with target-path is exist, and just reuse it. false otherwise.

isResuming

public boolean isResuming()

Specified by:

isResuming in interface ITaskHunter

Returns:

true if the currently downloading is the downloading resuming from the breakpoint. false downloading from the beginning.

getEtag

public String getEtag()

Specified by:

getEtag in interface ITaskHunter

Returns:

The Etag from the response's header.

isLargeFile

public boolean isLargeFile()

Specified by:

isLargeFile in interface ITaskHunter

Returns:

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

free

public void free()

Description copied from interface: ITaskHunter

Free the current hunter.

Specified by:

free in interface ITaskHunter

start

public void start()

Description copied from interface: ITaskHunter.IStarter

Start the task in the launcher thread.

Specified by:

start in interface ITaskHunter.IStarter

equalListener

public boolean equalListener(FileDownloadListener listener)

Specified by:

equalListener in interface ITaskHunter.IStarter

Parameters:

listener - The downloading listener.

Returns:

true if listener equal to the listener of the current task.