com.box.androidsdk.content.utils

Class ProgressOutputStream

java.lang.Object

java.io.OutputStream

com.box.androidsdk.content.utils.ProgressOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class ProgressOutputStream
extends java.io.OutputStream

An OutputStream that can report the progress of writing to another OutputStream to a ProgressListener.

Constructor Summary

Constructors

Constructor and Description
ProgressOutputStream(java.io.OutputStream stream, ProgressListener listener, long total) Constructs a ProgressOutputStream that wraps another OutputStream.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
long	getTotal() Returns the total number of bytes expected to be read from the stream.
void	setTotal(long total) Sets the total number of bytes expected to be read from the stream.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressOutputStream

public ProgressOutputStream(java.io.OutputStream stream,
                            ProgressListener listener,
                            long total)

Constructs a ProgressOutputStream that wraps another OutputStream.

Parameters:

stream - the stream whose progress will be monitored.

listener - the listener that will receive progress updates.

total - the total number of bytes that are expected to be read from the stream.

Method Detail

getTotal

public long getTotal()

Returns the total number of bytes expected to be read from the stream.

Returns:

the total number of bytes expected to be read from the stream.

setTotal

public void setTotal(long total)

Sets the total number of bytes expected to be read from the stream.

Parameters:

total - the total number of bytes that are expected to be read from the stream.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(byte[] b)
           throws java.io.IOException

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Overrides:

write in class java.io.OutputStream

Throws:

java.io.IOException

write

public void write(int b)
           throws java.io.IOException

Specified by:

write in class java.io.OutputStream

Throws:

java.io.IOException