net.covers1624.quack.net

Interface DownloadAction.Dest

Enclosing interface:

DownloadAction

public static interface DownloadAction.Dest

Interface for consuming the output of an HTTP response.

Method Summary

Modifier and Type	Method and Description
static DownloadAction.Dest	file(java.io.File file) Returns a DownloadAction.Dest which writes its content to a File.
java.lang.String	getEtag() Gets the ETag content for the resource.
long	getLastModified() Gets the LastModified timestamp millis for the current resource.
java.io.OutputStream	getOutputStream() Get the Okio OutputStream to push the data to.
void	onFinished(boolean success) Called when the file has finished downloading.
static DownloadAction.Dest	path(java.nio.file.Path path) Returns a DownloadAction.Dest which writes its content to a Path.
void	setEtag(java.lang.String etag) Set the ETag content for the current resource.
void	setLastModified(long time) Sets the LastModified timestamp millis for the current resource.
static DownloadAction.Dest	stream(java.io.OutputStream os) Returns a DownloadAction.Destwhich writes its content to a OutputStream.
static DownloadAction.Dest	string(java.io.StringWriter sw) Returns a DownloadAction.Dest which writes its content to a StringWriter.
static DownloadAction.Dest	string(java.io.StringWriter sw, java.nio.charset.Charset charset) Returns a DownloadAction.Dest which writes its content to a StringWriter.

Method Detail

getOutputStream

java.io.OutputStream getOutputStream()
                              throws java.io.IOException

Get the Okio OutputStream to push the data to.

Returns:

The OutputStream.

Throws:

java.io.IOException - If an error occurs opening the output.

getEtag

java.lang.String getEtag()
                  throws java.io.IOException

Gets the ETag content for the resource.

Returns:

The ETag content.

Throws:

java.io.IOException - If an IO Error occurs whilst reading the ETag content.

setEtag

void setEtag(java.lang.String etag)
      throws java.io.IOException

Set the ETag content for the current resource.

Parameters:

etag - The ETag content.

Throws:

java.io.IOException - If an IO Error occurs whilst writing the ETag content.

getLastModified

long getLastModified()
              throws java.io.IOException

Gets the LastModified timestamp millis for the current resource.

Returns:

The LastModified timestamp. Otherwise -1.

Throws:

java.io.IOException - If an IO Error occurs whilst reading the timestamp.

setLastModified

void setLastModified(long time)
              throws java.io.IOException

Sets the LastModified timestamp millis for the current resource.

Parameters:

time - The LastModified millis.

Throws:

java.io.IOException - If an IO Error occurs whilst reading the timestamp.

onFinished

void onFinished(boolean success)
         throws java.io.IOException

Called when the file has finished downloading.

Parameters:

success - If the operation finished successfully.

Throws:

java.io.IOException - If an IO Error occurs.

string

static DownloadAction.Dest string(java.io.StringWriter sw)

Returns a DownloadAction.Dest which writes its content to a StringWriter.

This method assumes StandardCharsets.UTF_8.

Parameters:

sw - The StringWriter.

Returns:

The DownloadAction.Dest.

string

static DownloadAction.Dest string(java.io.StringWriter sw,
                                  java.nio.charset.Charset charset)

Returns a DownloadAction.Dest which writes its content to a StringWriter.

The returned DownloadAction.Dest object does not support ETag or LastModified.

Parameters:

sw - The StringWriter.

charset - The charset to use.

Returns:

The DownloadAction.Dest.

stream

static DownloadAction.Dest stream(java.io.OutputStream os)

Returns a DownloadAction.Destwhich writes its content to a OutputStream.

The returned DownloadAction.Dest object does not support ETag or LastModified.

Parameters:

os - The OutputStream.

Returns:

The DownloadAction.Dest.

file

static DownloadAction.Dest file(java.io.File file)

Returns a DownloadAction.Dest which writes its content to a File.

Parameters:

file - The file.

Returns:

The DownloadAction.Dest.

path

static DownloadAction.Dest path(java.nio.file.Path path)

Returns a DownloadAction.Dest which writes its content to a Path.

Parameters:

path - The path.

Returns:

The DownloadAction.Dest.