javax.swing
class ProgressMonitorInputStream

java.lang.Object java.io.InputStream java.io.FilterInputStream javax.swing.ProgressMonitorInputStream

All Implemented Interfaces:

Closeable

public class ProgressMonitorInputStream
extends FilterInputStream

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.

ProgressMonitorInputStream

public ProgressMonitorInputStream(Component parentComponent,
                                  Object message,
                                  InputStream in)

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

Parameters:

parentComponent - The component triggering the operation being monitored.

message - Descriptive text to be placed in the dialog box if one is popped up.

in - The input stream to be monitored.

close

public void close()
           throws IOException

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

Overrides:

close in class FilterInputStream

Throws:

IOException

getProgressMonitor

public ProgressMonitor 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

Parameters:

b

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

Parameters:

b

off

len

Throws:

IOException

reset

public synchronized void reset()
                        throws IOException

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

Overrides:

reset 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

Parameters:

n

Throws:

IOException