Closeable
, AutoCloseable
public class ProgressMonitorInputStream extends FilterInputStream
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.
in
Constructor | Description |
---|---|
ProgressMonitorInputStream |
Constructs an object to monitor the progress of an input stream. |
Modifier and Type | Method | Description |
---|---|---|
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 |
Overrides FilterInputStream.read to update the progress monitor after the read. |
int |
read |
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 |
Overrides FilterInputStream.skip to update the progress monitor after the skip. |
available, mark, markSupported
nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo
public ProgressMonitorInputStream(Component parentComponent, Object message, InputStream in)
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 ProgressMonitor getProgressMonitor()
public int read() throws IOException
FilterInputStream.read
to update the progress monitor after the read.read
in class FilterInputStream
-1
if the end of the stream is reached.IOException
- if an I/O error occurs.public int read(byte[] b) throws IOException
FilterInputStream.read
to update the progress monitor after the read.read
in class FilterInputStream
b
- the buffer into which the data is read.-1
if there is no more data because the end of the stream has been reached.IOException
- if an I/O error occurs.public int read(byte[] b, int off, int len) throws IOException
FilterInputStream.read
to update the progress monitor after the read.read
in class FilterInputStream
b
- the buffer into which the data is read.off
- the start offset in array b
at which the data is written.len
- the maximum number of bytes to read.-1
if there is no more data because the end of the stream has been reached.IOException
- if an I/O error occurs.public long skip(long n) throws IOException
FilterInputStream.skip
to update the progress monitor after the skip.skip
in class FilterInputStream
n
- the number of bytes to be skipped.IOException
- if in.skip(n)
throws an IOException.public void close() throws IOException
FilterInputStream.close
to close the progress monitor as well as the stream.close
in interface AutoCloseable
close
in interface Closeable
close
in class FilterInputStream
IOException
- if an I/O error occurs.public void reset() throws IOException
FilterInputStream.reset
to reset the progress monitor as well as the stream.reset
in class FilterInputStream
IOException
- if this stream has not been marked or if the mark has been invalidated.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/ProgressMonitorInputStream.html