Class ProgressMonitorInputStream2

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

net.thevpc.common.mon.ProgressMonitorInputStream2

All Implemented Interfaces:

Closeable, AutoCloseable

public class ProgressMonitorInputStream2
extends FilterInputStream

this is a Monitors the progress of reading from some InputStream. This ProgressMonitor is normally invoked in roughly this form:

InputStream in = new BufferedInputStream(
                         new ProgressMonitorInputStream(
                                 parentComponent,
                                 "Reading " + fileName,
                                 new FileInputStream(fileName)));

This creates a progress monitor to monitor the progress of reading the input stream. If it's taking a while, a ProgressDialog will be popped up to inform the user. If the user hits the Cancel button an InterruptedIOException will be thrown on the next read. All the right cleanup is done when the stream is closed.

For further documentation and examples see How to Monitor Progress, a section in The Java Tutorial.

Version:

1.20 11/17/05

Author:

James Gosling

See Also:

• ProgressMonitor
• JOptionPane

Field Summary

Fields inherited from class FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
ProgressMonitorInputStream2(InputStream in, long size, ProgressMonitor pmonitor)	Constructs an object to monitor the progress of an input stream.

Method Summary

Modifier and Type	Method	Description
void	close()	Overrides FilterInputStream.close to close the progress monitor as well as the 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 FilterInputStream

available, mark, markSupported

Methods inherited from class InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class Object

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

Constructor Details

ProgressMonitorInputStream2

public ProgressMonitorInputStream2(InputStream in,
 long size,
 ProgressMonitor pmonitor)

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

Parameters:

in - The input stream to be monitored.

Method Details

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 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 monitor as well as the stream.

Overrides:

reset in class FilterInputStream

Throws:

IOException