javax.swing
Class ProgressMonitorInputStream
- java.lang.Object
-
- java.io.InputStream
-
- java.io.FilterInputStream
-
- javax.swing.ProgressMonitorInputStream
-
- All Implemented Interfaces:
- Closeable, AutoCloseable
public class ProgressMonitorInputStream extends FilterInputStream
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
-
-
Field Summary
-
Fields inherited from class java.io.FilterInputStream
in
-
-
Constructor Summary
Constructors Constructor and Description ProgressMonitorInputStream(Component parentComponent, Object message, InputStream in)Constructs an object to monitor the progress of an input stream.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description voidclose()OverridesFilterInputStream.closeto close the progress monitor as well as the stream.ProgressMonitorgetProgressMonitor()Get the ProgressMonitor object being used by this stream.intread()OverridesFilterInputStream.readto update the progress monitor after the read.intread(byte[] b)OverridesFilterInputStream.readto update the progress monitor after the read.intread(byte[] b, int off, int len)OverridesFilterInputStream.readto update the progress monitor after the read.voidreset()OverridesFilterInputStream.resetto reset the progress monitor as well as the stream.longskip(long n)OverridesFilterInputStream.skipto update the progress monitor after the skip.-
Methods inherited from class java.io.FilterInputStream
available, mark, markSupported
-
-
-
-
Constructor Detail
ProgressMonitorInputStream
public ProgressMonitorInputStream(Component parentComponent, Object message, InputStream in)
Constructs an object to monitor the progress of an input stream.- Parameters:
-
message- Descriptive text to be placed in the dialog box if one is popped up. -
parentComponent- The component triggering the operation being monitored. -
in- The input stream to be monitored.
-
Method Detail
getProgressMonitor
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
read
public int read() throws IOExceptionOverridesFilterInputStream.readto update the progress monitor after the read.- Overrides:
-
readin classFilterInputStream - Returns:
-
the next byte of data, or
-1if the end of the stream is reached. - Throws:
-
IOException- if an I/O error occurs. - See Also:
-
FilterInputStream.in
read
public int read(byte[] b) throws IOExceptionOverridesFilterInputStream.readto update the progress monitor after the read.- Overrides:
-
readin classFilterInputStream - Parameters:
-
b- the buffer into which the data is read. - Returns:
-
the total number of bytes read into the buffer, or
-1if there is no more data because the end of the stream has been reached. - Throws:
-
IOException- if an I/O error occurs. - See Also:
-
FilterInputStream.read(byte[], int, int)
read
public int read(byte[] b, int off, int len) throws IOExceptionOverridesFilterInputStream.readto update the progress monitor after the read.- Overrides:
-
readin classFilterInputStream - Parameters:
-
b- the buffer into which the data is read. -
off- the start offset in the destination arrayb -
len- the maximum number of bytes read. - Returns:
-
the total number of bytes read into the buffer, or
-1if there is no more data because the end of the stream has been reached. - Throws:
-
IOException- if an I/O error occurs. - See Also:
-
FilterInputStream.in
skip
public long skip(long n) throws IOExceptionOverridesFilterInputStream.skipto update the progress monitor after the skip.- Overrides:
-
skipin classFilterInputStream - Parameters:
-
n- the number of bytes to be skipped. - Returns:
- the actual number of bytes skipped.
- Throws:
-
IOException- if the stream does not support seek, or if some other I/O error occurs.
close
public void close() throws IOExceptionOverridesFilterInputStream.closeto close the progress monitor as well as the stream.- Specified by:
-
closein interfaceCloseable - Specified by:
-
closein interfaceAutoCloseable - Overrides:
-
closein classFilterInputStream - Throws:
-
IOException- if an I/O error occurs. - See Also:
-
FilterInputStream.in
reset
public void reset() throws IOExceptionOverridesFilterInputStream.resetto reset the progress monitor as well as the stream.- Overrides:
-
resetin classFilterInputStream - Throws:
-
IOException- if the stream has not been marked or if the mark has been invalidated. - See Also:
-
FilterInputStream.in,FilterInputStream.mark(int)
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
