com.dropbox.core

Class DbxStreamWriter<E extends Throwable>

java.lang.Object

com.dropbox.core.DbxStreamWriter<E>

Type Parameters:

E - The type of exception that your write(com.dropbox.core.NoThrowOutputStream) implementation might throw If your write implementation won't throw any checked exceptions, you should use RuntimeException for this parameter.

Direct Known Subclasses:

DbxStreamWriter.InputStreamCopier

public abstract class DbxStreamWriter<E extends Throwable>
extends Object

A callback for streaming data to an OutputStream, usually in the context of an API request being made by DbxClient.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbxStreamWriter.InputStreamCopier A DbxStreamWriter that gets its source data from the given InputStream.

Constructor Summary

Constructors

Constructor and Description
DbxStreamWriter()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close() Called when we're done with this object.
abstract void	write(NoThrowOutputStream out) Write all the data you plan to write to out.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbxStreamWriter

public DbxStreamWriter()

Method Detail

write

public abstract void write(NoThrowOutputStream out)
                    throws E extends Throwable

Write all the data you plan to write to out. Do not call close() on the stream (the stream will be closed automatically).

Throws:

E extends Throwable

close

public abstract void close()

Called when we're done with this object. This will be called even if the overall action fails so you have an opportunity to clean up resources.

For example, DbxClient.uploadFile(java.lang.String, com.dropbox.core.DbxWriteMode, long, java.io.InputStream) will call close() whether the upload succeeds or not. DbxStreamWriter.InputStreamCopier uses this method to close the underlying InputStream.