net.covers1624.quack.net

Class AbstractDownloadAction

java.lang.Object

net.covers1624.quack.net.AbstractDownloadAction

All Implemented Interfaces:

DownloadAction

Direct Known Subclasses:

ApacheHttpClientDownloadAction, HttpEngineDownloadAction, JavaDownloadAction, OkHttpDownloadAction

public abstract class AbstractDownloadAction
extends java.lang.Object
implements DownloadAction

Created by covers1624 on 16/12/21.

Nested Class Summary

Nested classes/interfaces inherited from interface net.covers1624.quack.net.DownloadAction

DownloadAction.Dest

Field Summary

Fields

Modifier and Type	Field and Description
protected @Nullable DownloadAction.Dest	dest
protected @Nullable DownloadListener	downloadListener
protected HeaderList	headerList
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	headers Deprecated.
protected boolean	onlyIfModified
protected boolean	quiet
protected boolean	upToDate
protected @Nullable java.lang.String	url
protected boolean	useETag
protected @Nullable java.lang.String	userAgent

Constructor Summary

Constructors

Constructor and Description
AbstractDownloadAction()

Method Summary

Modifier and Type	Method and Description
DownloadAction	addRequestHeader(java.lang.String key, java.lang.String value) Adds an arbitrary Http header to the action.
protected boolean	calcUpToDate(int code, long lastModifiedDisk, @Nullable java.util.Date lastModifiedHeader)
protected boolean	expectNotModified()
@Nullable DownloadAction.Dest	getDest()
@Nullable DownloadListener	getDownloadListener()
boolean	getOnlyIfModified()
boolean	getQuiet()
@Nullable java.lang.String	getUrl()
boolean	getUseETag()
@Nullable java.lang.String	getUserAgent()
boolean	isUpToDate()
AbstractDownloadAction	setDest(DownloadAction.Dest dest) Set the Destination to download content to.
AbstractDownloadAction	setDest(java.io.File file) Set the File to download content to.
AbstractDownloadAction	setDest(java.io.OutputStream os) Set the OutputStream to download content to.
AbstractDownloadAction	setDest(java.nio.file.Path path) Set the Path to download content to.
AbstractDownloadAction	setDest(java.io.StringWriter sw) Set the StringWriter to download content to.
AbstractDownloadAction	setDownloadListener(DownloadListener downloadListener) Set the DownloadListener to use.
AbstractDownloadAction	setOnlyIfModified(boolean onlyIfModified) If this Download action should use If-Modified-Since HTTP request header.
AbstractDownloadAction	setQuiet(boolean quiet) If this download action should not log things.
AbstractDownloadAction	setUrl(java.lang.String url) Set the URL to download from.
AbstractDownloadAction	setUseETag(boolean useETag) If this download action should use If-None-Match HTTP request header.
AbstractDownloadAction	setUserAgent(java.lang.String userAgent) Sets the User-Agent HTTP request header.
protected void	validateCode(int code, java.lang.String reasonPhrase)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.covers1624.quack.net.DownloadAction

execute

Field Detail

url

@Nullable
protected @Nullable java.lang.String url

dest

@Nullable
protected @Nullable DownloadAction.Dest dest

onlyIfModified

protected boolean onlyIfModified

useETag

protected boolean useETag

quiet

protected boolean quiet

userAgent

@Nullable
protected @Nullable java.lang.String userAgent

downloadListener

@Nullable
protected @Nullable DownloadListener downloadListener

headers

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="0.5")
protected final java.util.Map<java.lang.String,java.util.List<java.lang.String>> headers

Deprecated.

headerList

protected final HeaderList headerList

upToDate

protected boolean upToDate

Constructor Detail

AbstractDownloadAction

public AbstractDownloadAction()

Method Detail

expectNotModified

protected boolean expectNotModified()

validateCode

protected void validateCode(int code,
                            java.lang.String reasonPhrase)
                     throws HttpResponseException

Throws:

HttpResponseException

calcUpToDate

protected boolean calcUpToDate(int code,
                               long lastModifiedDisk,
                               @Nullable
                               @Nullable java.util.Date lastModifiedHeader)

setUrl

public AbstractDownloadAction setUrl(java.lang.String url)

Description copied from interface: DownloadAction

Set the URL to download from.

Specified by:

setUrl in interface DownloadAction

Parameters:

url - The URL.

Returns:

The same download action.

setDest

public AbstractDownloadAction setDest(DownloadAction.Dest dest)

Description copied from interface: DownloadAction

Set the Destination to download content to.

Specified by:

setDest in interface DownloadAction

Parameters:

dest - The Destination.

Returns:

The same download action.

setDest

public AbstractDownloadAction setDest(java.io.StringWriter sw)

Description copied from interface: DownloadAction

Set the StringWriter to download content to.

Specified by:

setDest in interface DownloadAction

Parameters:

sw - The StringWriter.

Returns:

The same download action.

setDest

public AbstractDownloadAction setDest(java.io.OutputStream os)

Description copied from interface: DownloadAction

Set the OutputStream to download content to.

Specified by:

setDest in interface DownloadAction

Parameters:

os - The OutputStream.

Returns:

The same download action.

setDest

public AbstractDownloadAction setDest(java.io.File file)

Description copied from interface: DownloadAction

Set the File to download content to.

Specified by:

setDest in interface DownloadAction

Parameters:

file - The file.

Returns:

The same download action.

setDest

public AbstractDownloadAction setDest(java.nio.file.Path path)

Description copied from interface: DownloadAction

Set the Path to download content to.

Specified by:

setDest in interface DownloadAction

Parameters:

path - The path.

Returns:

The same download action.

setOnlyIfModified

public AbstractDownloadAction setOnlyIfModified(boolean onlyIfModified)

Description copied from interface: DownloadAction

If this Download action should use If-Modified-Since HTTP request header.

Specified by:

setOnlyIfModified in interface DownloadAction

Parameters:

onlyIfModified - If If-Modified-Since should be used.

Returns:

The same download action.

setUseETag

public AbstractDownloadAction setUseETag(boolean useETag)

Description copied from interface: DownloadAction

If this download action should use If-None-Match HTTP request header.

Specified by:

setUseETag in interface DownloadAction

Parameters:

useETag - If If-None-Match should be used.

Returns:

The same download action.

setQuiet

public AbstractDownloadAction setQuiet(boolean quiet)

Description copied from interface: DownloadAction

If this download action should not log things.

Specified by:

setQuiet in interface DownloadAction

Parameters:

quiet - If the download action should be quiet.

Returns:

The same download action.

setUserAgent

public AbstractDownloadAction setUserAgent(java.lang.String userAgent)

Description copied from interface: DownloadAction

Sets the User-Agent HTTP request header.

Specified by:

setUserAgent in interface DownloadAction

Parameters:

userAgent - The User-Agent request header.

Returns:

The same download action.

addRequestHeader

public DownloadAction addRequestHeader(java.lang.String key,
                                       java.lang.String value)

Description copied from interface: DownloadAction

Adds an arbitrary Http header to the action.

Specified by:

addRequestHeader in interface DownloadAction

Parameters:

key - The key.

value - The value.

Returns:

The same download action.

setDownloadListener

public AbstractDownloadAction setDownloadListener(DownloadListener downloadListener)

Description copied from interface: DownloadAction

Set the DownloadListener to use.

Specified by:

setDownloadListener in interface DownloadAction

Parameters:

downloadListener - The DownloadListener.

Returns:

The same download action.

isUpToDate

public boolean isUpToDate()

Specified by:

isUpToDate in interface DownloadAction

getUrl

@Nullable
public @Nullable java.lang.String getUrl()

Specified by:

getUrl in interface DownloadAction

getDest

@Nullable
public @Nullable DownloadAction.Dest getDest()

Specified by:

getDest in interface DownloadAction

getOnlyIfModified

public boolean getOnlyIfModified()

Specified by:

getOnlyIfModified in interface DownloadAction

getUseETag

public boolean getUseETag()

Specified by:

getUseETag in interface DownloadAction

getQuiet

public boolean getQuiet()

Specified by:

getQuiet in interface DownloadAction

getUserAgent

@Nullable
public @Nullable java.lang.String getUserAgent()

Specified by:

getUserAgent in interface DownloadAction

getDownloadListener

@Nullable
public @Nullable DownloadListener getDownloadListener()

Specified by:

getDownloadListener in interface DownloadAction