de.cismet.tools.gui.downloadmanager

Interface Download

All Known Implementing Classes:

AbstractCancellableDownload, AbstractDownload, BackgroundTaskMultipleDownload, ByteArrayDownload, CredentialsAwareHttpDownlaod, HttpDownload, HttpOrFtpDownload, MultipleDownload, WebDavDownload

public interface Download

Download provides an enum and some methods which are to be implemented by any download implementation. A Download encapsulates all information to download files.

Version:

$Revision$, $Date$

Author:

jweintraut

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Download.State The state of a download.

Method Summary

Modifier and Type	Method and Description
void	addObserver(Observer o) A download can be observed for state changes.
void	deleteObserver(Observer o) A download can be observed for state changes.
Exception	getCaughtException() Returns the exception occurred while running this download.
int	getDownloadsCompleted() Returns the count of completed downloads this Download object encapsulates.
int	getDownloadsErroneous() Returns the count of erraneous downloads this Download object encapsulates.
int	getDownloadsTotal() Returns the count of downloads this Download object encapsulates.
JPanel	getExceptionPanel(Exception exception) Returns a JPanel which visualizes the given exception.
File	getFileToSaveTo() Returns the File object pointing to the destination download location.
default int	getProgress() If the state can be set to RUNNING_WITH_PROGRESS, than this method should be implemented and should return the current progress in percent.
Download.State	getStatus() Returns the current state of the download.
String	getTitle() Returns the title of the Download.
void	startDownload() Notifies the download that it should start.

Method Detail

startDownload

void startDownload()

Notifies the download that it should start.

getStatus

Download.State getStatus()

Returns the current state of the download.

Returns:

The state of the download.

getProgress

default int getProgress()

If the state can be set to RUNNING_WITH_PROGRESS, than this method should be implemented and should return the current progress in percent.

Returns:

the current progress in percent

addObserver

void addObserver(Observer o)

A download can be observed for state changes. Thus a download implementation should extend Observable. This method allows a download to add a new observer.

Parameters:

o - An observer to add.

deleteObserver

void deleteObserver(Observer o)

A download can be observed for state changes. Thus a download implementation should extend Observable. This method allows a download to remove an observer from the observer list.

Parameters:

o - The observer to remove.

getDownloadsTotal

int getDownloadsTotal()

Returns the count of downloads this Download object encapsulates.

Returns:

Total count of downloads.

getDownloadsCompleted

int getDownloadsCompleted()

Returns the count of completed downloads this Download object encapsulates.

Returns:

Count of completed downloads.

getDownloadsErroneous

int getDownloadsErroneous()

Returns the count of erraneous downloads this Download object encapsulates.

Returns:

Count of erraneous downloads.

getFileToSaveTo

File getFileToSaveTo()

Returns the File object pointing to the destination download location.

Returns:

Destination download location.

getCaughtException

Exception getCaughtException()

Returns the exception occurred while running this download. Should only be invoked if the status of this download equals an erroneous status.

Should be changed in future releases to Map getCaughtExceptions() for Download implementations which encapsulate multiple downloads.

Returns:

The exception that was caught while downloading.

getTitle

String getTitle()

Returns the title of the Download.

Returns:

The title of this download.

getExceptionPanel

JPanel getExceptionPanel(Exception exception)

Returns a JPanel which visualizes the given exception.

Parameters:

exception - The exception to visualize.

Returns:

A JPanel visualizing the given exception.