net.covers1624.quack.net.download

Interface DownloadSpec

All Known Implementing Classes:

DownloadAction, DownloadTask

Deprecated.

@Deprecated
public interface DownloadSpec

Inspired and vaguely based off https://github.com/michel-kraemer/gradle-download-task

 Notable differences:
  Wayyy simpler implementation.
  Lazy evaluation of file and URL inputs.
  Single file downloads.
  External validation of file for up-to-date checking.
  UserAgent spoofing. (Thanks mojang!)
  Ability to set the ProgressLogger to use.
 

This is split into an Action, Spec and Task.

The Spec DownloadSpec, Provides the specification for how things work.

The Action DownloadAction, What actually handles downloading implements DownloadSpec, Useful for other tasks that need to download something but not necessarily create an entire task to do said download.

The Task DownloadTask for gradle, Task wrapper for DownloadAction, implements DownloadSpec and hosts the Action as a task.

Created by covers1624 on 8/02/19.

Method Summary

Modifier and Type	Method and Description
void	fileUpToDateWhen(java.util.function.Predicate<java.nio.file.Path> spec) Deprecated. Spec to validate the already existing file this DownloadSpec will download.
java.nio.file.Path	getDest() Deprecated. Gets the destination file to download to.
java.nio.file.Path	getETagFile() Deprecated. The file to store the ETag in.
DownloadListener	getListener() Deprecated. Gets the currently attached DownloadListener.
boolean	getOnlyIfModified() Deprecated.
java.net.URL	getSrc() Deprecated. Gets the source URL for the file that will be downloaded.
DownloadAction.UseETag	getUseETag() Deprecated.
java.lang.String	getUserAgent() Deprecated. Gets the User-Agent header this DownloadSpec will use for requests.
boolean	isQuiet() Deprecated. If this DownloadSpec is being quiet.
boolean	isUpToDate() Deprecated. To be used after the DownloadSpec has been executed, will return weather the DownloadSpec was up-to-date and no work was performed.
default void	setDest(java.io.File dest) Deprecated. Sets the destination to store the downloaded file.
void	setDest(java.nio.file.Path dest) Deprecated. Sets the destination to store the downloaded file.
default void	setETagFile(java.io.File eTagFile) Deprecated. Sets the file to store the ETag in.
void	setETagFile(java.nio.file.Path eTagFile) Deprecated. Sets the file to store the ETag in.
void	setListener(DownloadListener listener) Deprecated. Forcibly set the DownloadListener to use for this DownloadSpec.
void	setOnlyIfModified(boolean onlyIfModified) Deprecated. Sets weather this DownloadSpec should obey onlyIfModified HTTP headers.
void	setQuiet(boolean quiet) Deprecated. Sets weather quiet is enabled or not.
void	setSrc(java.lang.Object src) Deprecated. Sets the source URL to download.
void	setUseETag(java.lang.Object useETag) Deprecated. Sets weather this DownloadSpec should use ETags for HTTP requests.
void	setUserAgent(java.lang.String userAgent) Deprecated. Sets the User-Agent HTTP header string to use for HTTP requests.

Method Detail

fileUpToDateWhen

void fileUpToDateWhen(java.util.function.Predicate<java.nio.file.Path> spec)

Deprecated.

Spec to validate the already existing file this DownloadSpec will download. If this spec returns true, its considered up-to-date, as long as eTag and onlyIfModified checks pass, the file will not be re-downloaded.

Basically, using this allows you to determine externally if the file is corrupt and force a re-download at execution time instead of pre maturely.

Parameters:

spec - The Spec.

getSrc

java.net.URL getSrc()

Deprecated.

Gets the source URL for the file that will be downloaded.

Returns:

The URL.

getDest

java.nio.file.Path getDest()

Deprecated.

Gets the destination file to download to.

Returns:

The file.

getOnlyIfModified

boolean getOnlyIfModified()

Deprecated.

Returns:

If this DownloadSpec checks for onlyIfModified HTTP headers.

getUseETag

DownloadAction.UseETag getUseETag()

Deprecated.

Returns:

The ETag validation method used by this DownloadSpec.

getETagFile

java.nio.file.Path getETagFile()

Deprecated.

The file to store the ETag in. Defaults to getDest + .etag

Returns:

The file to store the ETag in.

getUserAgent

java.lang.String getUserAgent()

Deprecated.

Gets the User-Agent header this DownloadSpec will use for requests.

Returns:

The User-Agent header.

isQuiet

boolean isQuiet()

Deprecated.

If this DownloadSpec is being quiet. Silences a few log messages and disables progress logging.

Returns:

If silent is enabled.

isUpToDate

boolean isUpToDate()

Deprecated.

To be used after the DownloadSpec has been executed, will return weather the DownloadSpec was up-to-date and no work was performed.

Returns:

If the DownloadSpec was up-to-date.

getListener

DownloadListener getListener()

Deprecated.

Gets the currently attached DownloadListener.

Returns:

The Listener.

setSrc

void setSrc(java.lang.Object src)

Deprecated.

Sets the source URL to download.

Parameters:

src - The source.

setDest

void setDest(java.nio.file.Path dest)

Deprecated.

Sets the destination to store the downloaded file.

Parameters:

dest - The destination.

setDest

default void setDest(java.io.File dest)

Deprecated.

Sets the destination to store the downloaded file.

Parameters:

dest - The destination.

setOnlyIfModified

void setOnlyIfModified(boolean onlyIfModified)

Deprecated.

Sets weather this DownloadSpec should obey onlyIfModified HTTP headers.

Parameters:

onlyIfModified - Weather to use onlyIfModified.

setUseETag

void setUseETag(java.lang.Object useETag)

Deprecated.

Sets weather this DownloadSpec should use ETags for HTTP requests.

Parameters:

useETag - Weather to use ETags.

setETagFile

void setETagFile(java.nio.file.Path eTagFile)

Deprecated.

Sets the file to store the ETag in. This defaults to getDest + .etag

Parameters:

eTagFile - The file to store the ETag in.

setETagFile

default void setETagFile(java.io.File eTagFile)

Deprecated.

Sets the file to store the ETag in. This defaults to getDest + .etag

Parameters:

eTagFile - The file to store the ETag in.

setUserAgent

void setUserAgent(java.lang.String userAgent)

Deprecated.

Sets the User-Agent HTTP header string to use for HTTP requests.

Parameters:

userAgent - The User-Agent string.

setQuiet

void setQuiet(boolean quiet)

Deprecated.

Sets weather quiet is enabled or not. Disables some log messages and progress logging.

Parameters:

quiet - If quiet is enabled.

setListener

void setListener(DownloadListener listener)

Deprecated.

Forcibly set the DownloadListener to use for this DownloadSpec. This bypasses quiet checks.

Parameters:

listener - The DownloadListener.