ProgressMonitorInputStream (Java Platform SE 7 ) (original) (raw)

• 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 seeHow to Monitor Progress, a section in The Java Tutorial.
See Also:
ProgressMonitor, JOptionPane

• • Field Summary

     * ### Fields inherited from class java.io.[FilterInputStream](../../java/io/FilterInputStream.html "class in java.io")  
     `[in](../../java/io/FilterInputStream.html#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() 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](../../java/io/FilterInputStream.html "class in java.io")  
     `[available](../../java/io/FilterInputStream.html#available%28%29), [mark](../../java/io/FilterInputStream.html#mark%28int%29), [markSupported](../../java/io/FilterInputStream.html#markSupported%28%29)`  
     * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
     `[clone](../../java/lang/Object.html#clone%28%29), [equals](../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../java/lang/Object.html#finalize%28%29), [getClass](../../java/lang/Object.html#getClass%28%29), [hashCode](../../java/lang/Object.html#hashCode%28%29), [notify](../../java/lang/Object.html#notify%28%29), [notifyAll](../../java/lang/Object.html#notifyAll%28%29), [toString](../../java/lang/Object.html#toString%28%29), [wait](../../java/lang/Object.html#wait%28%29), [wait](../../java/lang/Object.html#wait%28long%29), [wait](../../java/lang/Object.html#wait%28long,%20int%29)`

• • Constructor Detail

     * #### ProgressMonitorInputStream  
     public ProgressMonitorInputStream([Component](../../java/awt/Component.html "class in java.awt") parentComponent,  
                               [Object](../../java/lang/Object.html "class in java.lang") message,  
                               [InputStream](../../java/io/InputStream.html "class in java.io") 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](../../javax/swing/ProgressMonitor.html "class in javax.swing") 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](../../java/io/IOException.html "class in java.io")  
    Overrides `FilterInputStream.read` to update the progress monitor after the read.  
    **Overrides:**  
    `[read](../../java/io/FilterInputStream.html#read%28%29)` in class `[FilterInputStream](../../java/io/FilterInputStream.html "class in java.io")`  
    Returns:  
    the next byte of data, or `-1` if the end of the stream is reached.  
    Throws:  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
    See Also:  
    [FilterInputStream.in](../../java/io/FilterInputStream.html#in)  
    * #### read  
    public int read(byte[] b)  
             throws [IOException](../../java/io/IOException.html "class in java.io")  
    Overrides `FilterInputStream.read` to update the progress monitor after the read.  
    **Overrides:**  
    `[read](../../java/io/FilterInputStream.html#read%28byte[]%29)` in class `[FilterInputStream](../../java/io/FilterInputStream.html "class in java.io")`  
    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](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
    See Also:  
    [FilterInputStream.read(byte\[\], int, int)](../../java/io/FilterInputStream.html#read%28byte[],%20int,%20int%29)  
    * #### read  
    public int read(byte[] b,  
           int off,  
           int len)  
             throws [IOException](../../java/io/IOException.html "class in java.io")  
    Overrides `FilterInputStream.read` to update the progress monitor after the read.  
    **Overrides:**  
    `[read](../../java/io/FilterInputStream.html#read%28byte[],%20int,%20int%29)` in class `[FilterInputStream](../../java/io/FilterInputStream.html "class in java.io")`  
    Parameters:  
    `b` \- the buffer into which the data is read.  
    `off` \- the start offset in the destination array `b`  
    `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](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
    See Also:  
    [FilterInputStream.in](../../java/io/FilterInputStream.html#in)  
    * #### skip  
    public long skip(long n)  
              throws [IOException](../../java/io/IOException.html "class in java.io")  
    Overrides `FilterInputStream.skip` to update the progress monitor after the skip.  
    **Overrides:**  
    `[skip](../../java/io/FilterInputStream.html#skip%28long%29)` in class `[FilterInputStream](../../java/io/FilterInputStream.html "class in java.io")`  
    Parameters:  
    `n` \- the number of bytes to be skipped.  
    Returns:  
    the actual number of bytes skipped.  
    Throws:  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if the stream does not support seek, or if some other I/O error occurs.  
    * #### close  
    public void close()  
               throws [IOException](../../java/io/IOException.html "class in java.io")  
    Overrides `FilterInputStream.close` to close the progress monitor as well as the stream.  
    **Specified by:**  
    `[close](../../java/io/Closeable.html#close%28%29)` in interface `[Closeable](../../java/io/Closeable.html "interface in java.io")`  
    **Specified by:**  
    `[close](../../java/lang/AutoCloseable.html#close%28%29)` in interface `[AutoCloseable](../../java/lang/AutoCloseable.html "interface in java.lang")`  
    **Overrides:**  
    `[close](../../java/io/FilterInputStream.html#close%28%29)` in class `[FilterInputStream](../../java/io/FilterInputStream.html "class in java.io")`  
    Throws:  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
    See Also:  
    [FilterInputStream.in](../../java/io/FilterInputStream.html#in)  
    * #### reset  
    public void reset()  
               throws [IOException](../../java/io/IOException.html "class in java.io")  
    Overrides `FilterInputStream.reset` to reset the progress monitor as well as the stream.  
    **Overrides:**  
    `[reset](../../java/io/FilterInputStream.html#reset%28%29)` in class `[FilterInputStream](../../java/io/FilterInputStream.html "class in java.io")`  
    Throws:  
    `[IOException](../../java/io/IOException.html "class in java.io")` \- if the stream has not been marked or if the mark has been invalidated.  
    See Also:  
    [FilterInputStream.in](../../java/io/FilterInputStream.html#in), [FilterInputStream.mark(int)](../../java/io/FilterInputStream.html#mark%28int%29)

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, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.