|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object extended by java.io.InputStream extended by java.io.FilterInputStream extended by 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.
ProgressMonitor,
JOptionPane
| 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)
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 |
|---|
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.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.
IOException - if an I/O error occurs.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.
IOException - if an I/O error occurs.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.
IOException - if an I/O error occurs.public void close() throws IOException
FilterInputStream.close
to close the progress monitor as well as the stream.
close in interface Closeableclose in class FilterInputStreamIOException - if an I/O error occurs.FilterInputStream.inpublic void reset() throws IOException
FilterInputStream.reset
to reset the progress monitor as well as the stream.
reset in class FilterInputStreamIOException - if the stream has not been marked or if the
mark has been invalidated.FilterInputStream.in,
FilterInputStream.mark(int)
|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.