de.ipk_gatersleben.bit.bi.edal.publication.metadata

Class FileProgressInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

de.ipk_gatersleben.bit.bi.edal.publication.metadata.FileProgressInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class FileProgressInputStream
extends FilterInputStream

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
FileProgressInputStream(JProgressBar fileProgressBar, InputStream inputStream) Constructs an object to monitor the progress of an input stream.

Method Summary

Modifier and Type	Method and Description
void	close() Overrides FilterInputStream.close to close the progress monitor as well as the stream.
FileProgressMonitor	getProgressMonitor() Get the ProgressMonitor object being used by this stream.
int	read() Overrides FilterInputStream.read to update the progress monitor after the read.
int	read(byte[] b) Overrides FilterInputStream.read to update the progress monitor after the read.
int	read(byte[] b, int off, int len) Overrides FilterInputStream.read to update the progress monitor after the read.
void	reset() Overrides FilterInputStream.reset to reset the progress monitor as well as the stream.
long	skip(long n) Overrides FilterInputStream.skip to update the progress monitor after the skip.

Methods inherited from class java.io.FilterInputStream

available, mark, markSupported

Methods inherited from class java.lang.Object

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

Constructor Detail

FileProgressInputStream

public FileProgressInputStream(JProgressBar fileProgressBar,
                               InputStream inputStream)

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

Parameters:

inputStream - The input stream to be monitored.

fileProgressBar - the corresponding JProgressBar

Method Detail

getProgressMonitor

public FileProgressMonitor getProgressMonitor()

Get the ProgressMonitor object being used by this stream. Normally this isn't needed unless you want to do something like change the descriptive text partway through reading the file.

Returns:

the ProgressMonitor object used by this object

read

public int read()
         throws IOException

Overrides FilterInputStream.read to update the progress monitor 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 monitor 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 monitor 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 monitor after the skip.

Overrides:

skip in class FilterInputStream

Throws:

IOException

close

public void close()
           throws IOException

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

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FilterInputStream

Throws:

IOException

reset

public void reset()
           throws IOException

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

Overrides:

reset in class FilterInputStream

Throws:

IOException