java.lang.Objectjava.io.InputStream
java.io.FilterInputStream
javax.swing.ProgressMonitorInputStream
public class ProgressMonitorInputStream
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.
Field Summary |
---|
Fields inherited from class java.io. FilterInputStream |
---|
in |
Constructor Summary | |
---|---|
ProgressMonitorInputStream
(
Component
parentComponent,
Object
message,
InputStream
in) Constructs an object to monitor the progress of an input stream. |
Method Summary | |
---|---|
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
() 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 java.io. FilterInputStream |
---|
available , mark , markSupported |
Methods inherited from class java.lang. Object |
---|
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
Constructor Detail |
---|
public ProgressMonitorInputStream(Component parentComponent, Object message, InputStream in)
Method Detail |
---|
public ProgressMonitor getProgressMonitor()
public int read() throws IOException
public int read(byte[] b) throws IOException
public int read(byte[] b, int off, int len) throws IOException
public long skip(long n) throws IOException
public void close() throws IOException
public void reset() throws IOException