- 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
Methods Modifier and Type Method and Description void
close()
OverridesFilterInputStream.close
to close the progress monitor as well as the stream.ProgressMonitor
getProgressMonitor()
Get the ProgressMonitor object being used by this stream.int
read()
OverridesFilterInputStream.read
to update the progress monitor after the read.int
read(byte[] b)
OverridesFilterInputStream.read
to update the progress monitor after the read.int
read(byte[] b, int off, int len)
OverridesFilterInputStream.read
to update the progress monitor after the read.void
reset()
OverridesFilterInputStream.reset
to reset the progress monitor as well as the stream.long
skip(long n)
OverridesFilterInputStream.skip
to 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 IOException
OverridesFilterInputStream.read
to update the progress monitor after the read.- Overrides:
read
in classFilterInputStream
- Returns:
- the next byte of data, or
-1
if 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 IOException
OverridesFilterInputStream.read
to update the progress monitor after the read.- Overrides:
read
in classFilterInputStream
- Parameters:
b
- the buffer into which the data is read.- Returns:
- the total number of bytes read into the buffer, or
-1
if 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 IOException
OverridesFilterInputStream.read
to update the progress monitor after the read.- Overrides:
read
in 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
-1
if 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 IOException
OverridesFilterInputStream.skip
to update the progress monitor after the skip.- Overrides:
skip
in 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 IOException
OverridesFilterInputStream.close
to close the progress monitor as well as the stream.- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceAutoCloseable
- Overrides:
close
in classFilterInputStream
- Throws:
IOException
- if an I/O error occurs.- See Also:
FilterInputStream.in
-
reset
public void reset() throws IOException
OverridesFilterInputStream.reset
to reset the progress monitor as well as the stream.- Overrides:
reset
in classFilterInputStream
- Throws:
IOException
- if the stream has not been marked or if the mark has been invalidated.- See Also:
FilterInputStream.in
,FilterInputStream.mark(int)
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/progressmonitorinputstream.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.