com.dropbox.core.v2.files

Class DownloadBuilder

java.lang.Object

com.dropbox.core.v2.DbxDownloadStyleBuilder<FileMetadata>

com.dropbox.core.v2.files.DownloadBuilder

public class DownloadBuilder
extends DbxDownloadStyleBuilder<FileMetadata>

The request builder returned by DbxUserFilesRequests.downloadBuilder(java.lang.String).

Use this class to set optional request parameters and complete the request.

Method Summary

Modifier and Type	Method and Description
DbxDownloader<FileMetadata>	start() Issues the download request using this builder's request parameters and returns a DbxDownloader for reading the response body.
DownloadBuilder	withRev(String rev) Set value for optional field.

Methods inherited from class com.dropbox.core.v2.DbxDownloadStyleBuilder

download, getHeaders, range, range

Methods inherited from class java.lang.Object

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

Method Detail

withRev

public DownloadBuilder withRev(String rev)

Set value for optional field.

Parameters:

rev - Deprecated. Please specify revision in the path argument to DbxUserFilesRequests.download(String,String) instead. Must have length of at least 9 and match pattern "[0-9a-f]+".

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

start

public DbxDownloader<FileMetadata> start()
                                  throws DownloadErrorException,
                                         DbxException

Description copied from class: DbxDownloadStyleBuilder

Issues the download request using this builder's request parameters and returns a DbxDownloader for reading the response body. Callers should fully read the response body using DbxDownloader.getInputStream() and close the downloader afterwards (see DbxDownloader.close()). This will allow for proper resource deallocation and connection re-use.. See DbxDownloadStyleBuilder.download(java.io.OutputStream) convenience method for a simpler way to complete the request.

Specified by:

start in class DbxDownloadStyleBuilder<FileMetadata>

Returns:

DbxDownloader used to download data and read the response.

Throws:

DbxException - if an error occursing issuing the request

DownloadErrorException