public class

ProgressMonitorInputStream

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

Class Overview

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.

Summary

[Expand]
Inherited Fields
From class java.io.FilterInputStream
Public Constructors
ProgressMonitorInputStream(Component parentComponent, Object message, InputStream in)
Constructs an object to monitor the progress of an input stream.
Public Methods
void close()
Overrides FilterInputStream.close to close the progress monitor as well as the stream.
ProgressMonitor getProgressMonitor()
Get the ProgressMonitor object being used by this stream.
int read(byte[] b)
Overrides FilterInputStream.read to update the progress monitor after the read.
int read()
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.
synchronized 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.
[Expand]
Inherited Methods
From class java.io.FilterInputStream
From class java.io.InputStream
From class java.lang.Object
From interface java.io.Closeable

Public Constructors

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.

Public Methods

public void close ()

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

Throws
IOException

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

public int read (byte[] b)

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

Parameters
b the buffer into which the data is read.
Returns
  • the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.
Throws
IOException

public int read ()

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

Returns
  • the next byte of data, or -1 if the end of the stream is reached.
Throws
IOException

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

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

Parameters
b the buffer into which the data is read.
off the start offset in the destination array b
len the maximum number of bytes read.
Returns
  • the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.
Throws
IOException

public synchronized void reset ()

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

Throws
IOException

public long skip (long n)

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

Parameters
n the number of bytes to be skipped.
Returns
  • the actual number of bytes skipped.
Throws
IOException