com.box.androidsdk.content.utils

Class ProgressInputStream

java.lang.Object

java.io.InputStream

com.box.androidsdk.content.utils.ProgressInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ProgressInputStream
extends java.io.InputStream

An InputStream that can report the progress of reading from another InputStream to a ProgressListener.

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.io.InputStream

available, mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressInputStream

public ProgressInputStream(java.io.InputStream stream,
                           ProgressListener listener,
                           long total)

Constructs a ProgressInputStream that wraps another InputStream.

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()

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

Returns:

the total number of bytes.

setTotal

public void setTotal(long total)

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

Parameters:

total - the total number of bytes

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.InputStream

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException