Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Java Platform 1.2
Beta 4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Class com.sun.java.swing.ProgressMonitorInputStream

java.lang.Object
  |
  +--java.io.InputStream
        |
        +--java.io.FilterInputStream
              |
              +--com.sun.java.swing.ProgressMonitorInputStream

public class ProgressMonitorInputStream

extends FilterInputStream

Monitors the progress of reading from some InputStream. 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.

See Also:

ProgressMonitor, JOptionPane

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

ProgressMonitorInputStream(Component parentComponent, Object message, InputStream in)

Method Summary

void	close()
ProgressMonitor	getProgressMonitor()
int	read()
int	read(byte[] b, int off, int len)
int	read(byte[] b)
void	reset()
long	skip(long n)

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

ProgressMonitorInputStream

public ProgressMonitorInputStream(Component parentComponent,
                                  Object message,
                                  InputStream in)

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()

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class FilterInputStream

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class FilterInputStream

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class FilterInputStream

close

public void close()
           throws IOException

Overrides:

close in class FilterInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream