com.dropbox.core

Class DbxClient.Uploader

java.lang.Object

com.dropbox.core.DbxClient.Uploader

Enclosing class:

DbxClient

public static final class DbxClient.Uploader
extends Object

For uploading file content to Dropbox. Write stuff to the body stream.

Don't call close() directly on the body. Instead call either call either finish() or close() to make sure the stream and other resources are released. A safe idiom is to use the object within a try block and put a call to close() in the finally block.

 DbxClient.Uploader uploader = ...
 try {
     uploader.body.write("Hello, world!".getBytes("UTF-8"));
     uploader.finish();
 }
 finally {
     uploader.close();
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
OutputStream	body

Constructor Summary

Constructors

Constructor and Description
DbxClient.Uploader(HttpRequestor.Uploader httpUploader, long claimedBytes)

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Cancel the upload.
void	close() Release the resources related to this Uploader instance.
DbxEntry.File	finish() When you're done writing the file contents to body, call this to indicate that you're done.

Methods inherited from class java.lang.Object

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

Field Detail

body

public final OutputStream body

Constructor Detail

DbxClient.Uploader

public DbxClient.Uploader(HttpRequestor.Uploader httpUploader,
                  long claimedBytes)

Method Detail

abort

public void abort()

Cancel the upload.

close

public void close()

Release the resources related to this Uploader instance. If close() or abort() has already been called, this does nothing. If neither has been called, this is equivalent to calling abort().

finish

public DbxEntry.File finish()
                     throws DbxException

When you're done writing the file contents to body, call this to indicate that you're done. This will actually finish the underlying HTTP request and return the uploaded file's DbxEntry.

Throws:

DbxException