javax.swing.ProgressMonitorInputStream — clojure-interop/javax.swing 1.0.5

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.

->progress-monitor-input-stream clj

(->progress-monitor-input-stream parent-component message in)

Constructor.

Constructs an object to monitor the progress of an input stream.

parent-component - The component triggering the operation being monitored. - java.awt.Component message - Descriptive text to be placed in the dialog box if one is popped up. - java.lang.Object in - The input stream to be monitored. - java.io.InputStream

close clj

(close this)

Overrides FilterInputStream.close to close the progress monitor as well as the stream.

throws: java.io.IOException - if an I/O error occurs.

get-progress-monitor clj

(get-progress-monitor this)

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 - javax.swing.ProgressMonitor

read clj

(read this)

(read this b)

(read this b off len)

Overrides FilterInputStream.read to update the progress monitor after the read.

b - the buffer into which the data is read. - byte[] off - the start offset in the destination array b - int len - the maximum number of bytes read. - int

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. - int

throws: java.io.IOException - if an I/O error occurs.

reset clj

(reset this)

Overrides FilterInputStream.reset to reset the progress monitor as well as the stream.

throws: java.io.IOException - if the stream has not been marked or if the mark has been invalidated.

skip clj

(skip this n)

Overrides FilterInputStream.skip to update the progress monitor after the skip.

n - the number of bytes to be skipped. - long

returns: the actual number of bytes skipped. - long

throws: java.io.IOException - if the stream does not support seek, or if some other I/O error occurs.