com.alee.utils.file

Interface FileDownloadListener

All Superinterfaces:

EventListener

public interface FileDownloadListener
extends EventListener

This listener interface provides all required methods to observe and manipulate the download process. Check out downloadFile methods from FileUtils to see how this listener can be used.

Author:

Mikle Garin

Method Summary

Modifier and Type	Method and Description
void	fileDownloadAborted() Called when file download was aborted, usually due to shouldStopDownload() returning true.
void	fileDownloaded(File file) Called when file download completed.
void	fileDownloadFailed(Throwable e) Called when file download has failed.
void	partDownloaded(int totalBytesDownloaded) Called when another file part have been downloaded.
boolean	shouldStopDownload() Returns whether download operation should stop or not.
void	sizeDetermined(int totalSize) Called when remote file size retrieved.

Method Detail

sizeDetermined

void sizeDetermined(int totalSize)

Called when remote file size retrieved.

Parameters:

totalSize - file size

partDownloaded

void partDownloaded(int totalBytesDownloaded)

Called when another file part have been downloaded.

Parameters:

totalBytesDownloaded - total bytes downloaded so far

fileDownloaded

void fileDownloaded(@NotNull
                    File file)

Called when file download completed.

Parameters:

file - downloaded local file

fileDownloadAborted

void fileDownloadAborted()

Called when file download was aborted, usually due to shouldStopDownload() returning true.

fileDownloadFailed

void fileDownloadFailed(@NotNull
                        Throwable e)

Called when file download has failed.

Parameters:

e - exception that caused download to fail

shouldStopDownload

boolean shouldStopDownload()

Returns whether download operation should stop or not. This method is getting called before and after each time-consuming operation (for example file part download).

Returns:

true if you want to stop download, false otherwise