net.sf.kdgcommons.io

Class MonitoredOutputStream

java.lang.Object

java.io.OutputStream

net.sf.kdgcommons.io.MonitoredOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class MonitoredOutputStream
extends OutputStream

A decorator OutputStream that invokes a progress(long, long) method after each write, reporting the number of bytes processed. Applications can subclass and override this method to provide features such as a progress bar.

Constructor Summary

Constructors

Constructor and Description
MonitoredOutputStream(OutputStream delegate)

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
void	progress(long lastWrite, long totalBytes) Called after each operation that writes bytes, to report the number of bytes written.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MonitoredOutputStream

public MonitoredOutputStream(OutputStream delegate)

Method Detail

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

progress

public void progress(long lastWrite,
                     long totalBytes)

Called after each operation that writes bytes, to report the number of bytes written. The default implementation of this method is a no-op.

Parameters:

lastWrite - Number of bytes in last write operation. Note that this may be 0.

totalBytes - Total number of bytes read or skipped since this class was instantiated.