Package org.esa.snap.core.util.io

Class ObservableInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.esa.snap.core.util.io.ObservableInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ObservableInputStream
extends FilterInputStream

An input stream which can be used to observer progress of reading from some other input stream.

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
ObservableInputStream(InputStream in, long size, InputStreamObserver listener)	Constructs an object to observer the progress of an input stream.
ObservableInputStream(InputStream in, InputStreamObserver listener)	Constructs an object to observer the progress of an input stream.

Method Summary

Modifier and Type	Method	Description
void	close()	Overrides FilterInputStream.close to close the progress observer as well as the stream.
long	getNumBytesRead()
long	getNumBytesTotal()
InputStreamObserver	getObserver()
int	read()	Overrides FilterInputStream.read to update the progress observer after the read.
int	read(byte[] b)	Overrides FilterInputStream.read to update the progress observer after the read.
int	read(byte[] b, int off, int len)	Overrides FilterInputStream.read to update the progress observer after the read.
void	reset()	Overrides FilterInputStream.reset to reset the progress observer as well as the stream.
long	skip(long n)	Overrides FilterInputStream.skip to update the progress observer after the skip.

Methods inherited from class java.io.FilterInputStream

available, mark, markSupported

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

ObservableInputStream

public ObservableInputStream(InputStream in,
                             InputStreamObserver listener)

Constructs an object to observer the progress of an input stream.

Parameters:

in - The input stream to be monitored.

listener - the listener to be informed

ObservableInputStream

public ObservableInputStream(InputStream in,
                             long size,
                             InputStreamObserver listener)

Constructs an object to observer the progress of an input stream.

Parameters:

in - The input stream to be monitored.

listener - the listener to be informed

Method Detail

getNumBytesTotal

public long getNumBytesTotal()

getNumBytesRead

public long getNumBytesRead()

getObserver

public InputStreamObserver getObserver()

read

public int read()
         throws IOException

Overrides FilterInputStream.read to update the progress observer after the read.

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides FilterInputStream.read to update the progress observer after the read.

Overrides:

read in class FilterInputStream

Throws:

IOException

read

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

Overrides FilterInputStream.read to update the progress observer after the read.

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides FilterInputStream.skip to update the progress observer after the skip.

Overrides:

skip in class FilterInputStream

Throws:

IOException

close

public void close()
           throws IOException

Overrides FilterInputStream.close to close the progress observer as well as the stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterInputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides FilterInputStream.reset to reset the progress observer as well as the stream.

Overrides:

reset in class FilterInputStream

Throws:

IOException