ProgressMonitorInputStream JDK 1.6)

Description

public class ProgressMonitorInputStream

Monitors the progress of reading from some InputStream.

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.

See also: ProgressMonitor JOptionPane

Methods

Hide/Show inherited methods

public int available () throws IOException [Inherited From FilterInputStream]

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.

public void close () throws IOException [Overrides FilterInputStream]

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

public ProgressMonitor getProgressMonitor ()

Get the ProgressMonitor object being used by this stream.

publicsynchronized void mark (int readlimit) [Inherited From FilterInputStream]

Marks the current position in this input stream.

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

This method simply performs in.mark(readlimit).
Parameters:
- readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.
See Also: FilterInputStream.in, FilterInputStream.reset(),

public boolean markSupported () [Inherited From FilterInputStream]

Tests if this input stream supports the mark and reset methods.

Tests if this input stream supports the mark
and reset methods.
This method
simply performs in.markSupported().
Returns: true if this stream type supports the mark and reset method; false otherwise.
See Also: FilterInputStream.in, InputStream.mark(int), InputStream.reset(),

public int read () throws IOException [Overrides FilterInputStream] [Specified in InputStream]

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

public int read (byte[] b) throws IOException [Overrides FilterInputStream]

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

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

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

publicsynchronized void reset () throws IOException [Overrides FilterInputStream]

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

public long skip (long n) throws IOException [Overrides FilterInputStream]

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