java.lang.Object | +--java.io.InputStream | +--java.io.FilterInputStream | +--javax.swing.ProgressMonitorInputStream
Unsafe: 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.
ProgressMonitor,
JOptionPaneProgressMonitorInputStream(Component parentComponent,
Object message,
InputStream in)
void
close()
FilterInputStream.close
to close the progress monitor as well as the stream.
ProgressMonitor
getProgressMonitor()
int
read(byte[] b)
FilterInputStream.read
to update the progress monitor after the read.
int
read(byte[] b,
int off,
int len)
FilterInputStream.read
to update the progress monitor after the read.
void
reset()
FilterInputStream.reset
to reset the progress monitor as well as the stream.
long
skip(long n)
FilterInputStream.skip
to update the progress monitor after the skip.
private ProgressMonitor monitor
private int nread
private int size
public ProgressMonitorInputStream(Component parentComponent, Object message, InputStream in)
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.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.
IOExceptionjava.io.FilterInputStream#inpublic int read(byte[] b) throws IOException
FilterInputStream.read
to update the progress monitor after the read.
read in class FilterInputStreamb - the buffer into which the data is read.
-1 if there is no more data because the end of
the stream has been reached.
IOExceptionjava.io.FilterInputStream#read(byte[], int, int)public int read(byte[] b, int off, int len) throws IOException
FilterInputStream.read
to update the progress monitor after the read.
read in class FilterInputStreamb - the buffer into which the data is read.off - the start offset of the data.len - the maximum number of bytes read.
-1 if there is no more data because the end of
the stream has been reached.
IOExceptionjava.io.FilterInputStream#inpublic long skip(long n) throws IOException
FilterInputStream.skip
to update the progress monitor after the skip.
skip in class FilterInputStreamn - the number of bytes to be skipped.
IOExceptionpublic void close() throws IOException
FilterInputStream.close
to close the progress monitor as well as the stream.
close in class FilterInputStreamIOExceptionjava.io.FilterInputStream#inpublic void reset() throws IOException
FilterInputStream.reset
to reset the progress monitor as well as the stream.
reset in class FilterInputStreamIOExceptionjava.io.FilterInputStream#in,
java.io.FilterInputStream#mark(int)