com.pb.downloadmanager.api

Class DownloadResult

java.lang.Object

com.pb.downloadmanager.api.DownloadResult

public final class DownloadResult
extends java.lang.Object

This class contains information about the result of the download. The download contains a path to a file or directory on the local file system. A Downloader may skip the downloading step if the resource is already downloaded and that skip is captured in this result.

Constructor Summary

Constructors

Constructor and Description
DownloadResult()

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	getDownload() The download is the local filesystem path of the resource that was requested.
boolean	isDownloadSkipped() A Downloader may skip the download process if the requested resource already exists on the local filesystem.
void	setDownload(java.nio.file.Path download) For a Downloader to set the location of the download
void	setDownloadSkipped(boolean downloadSkipped) For a Downloader to signal that a download did not occur.

Methods inherited from class java.lang.Object

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

Constructor Detail

DownloadResult

public DownloadResult()

Method Detail

isDownloadSkipped

public boolean isDownloadSkipped()

A Downloader may skip the download process if the requested resource already exists on the local filesystem. This may be because a previous download request downloaded the resource and the resource has not been modified since. This also may occur if the requested path was already a local file system path.

Returns:

true if a download did not occur

setDownloadSkipped

public void setDownloadSkipped(boolean downloadSkipped)

For a Downloader to signal that a download did not occur.

Parameters:

downloadSkipped - true if a download did not occur

setDownload

public void setDownload(java.nio.file.Path download)

For a Downloader to set the location of the download

Parameters:

download - a path representing the directory or file that was downloaded

getDownload

public java.nio.file.Path getDownload()

The download is the local filesystem path of the resource that was requested. If a file was requested then the download path will be a file. If a directory was requested then the download path will be a directory. If an archive was requested with the unarchive flag and the Downloader supported the archive type then the download path will be a directory.

Returns:

a path from the local file system