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 protected InputStream in The input stream to be filtered.

[Expand] Inherited Methods
From class java.io.FilterInputStream int available() 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. void close() Closes this input stream and releases any system resources associated with the stream. synchronized void mark(int readlimit) Marks the current position in this input stream. boolean markSupported() Tests if this input stream supports the mark and reset methods. int read(byte[] b) Reads up to byte.length bytes of data from this input stream into an array of bytes. int read() Reads the next byte of data from this input stream. int read(byte[] b, int off, int len) Reads up to len bytes of data from this input stream into an array of bytes. synchronized void reset() Repositions this stream to the position at the time the mark method was last called on this input stream. long skip(long n) Skips over and discards n bytes of data from this input stream. This method simply performs in.skip(n).
From class java.io.InputStream int available() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. void close() Closes this input stream and releases any system resources associated with the stream. synchronized void mark(int readlimit) Marks the current position in this input stream. boolean markSupported() Tests if this input stream supports the mark and reset methods. int read(byte[] b) Reads some number of bytes from the input stream and stores them into the buffer array b. abstract int read() Reads the next byte of data from the input stream. int read(byte[] b, int off, int len) Reads up to len bytes of data from the input stream into an array of bytes. synchronized void reset() Repositions this stream to the position at the time the mark method was last called on this input stream. long skip(long n) Skips over and discards n bytes of data from this input stream.
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait() Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object. final void wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the notify() method or the notifyAll() method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed. final void wait(long timeout) Causes the current thread to wait until either another thread invokes the notify() method or the notifyAll() method for this object, or a specified amount of time has elapsed.
From interface java.io.Closeable abstract void close() Closes this stream and releases any system resources associated with it.