org.jets3t.service.io
Class ProgressMonitoredOutputStream
java.lang.Object
java.io.OutputStream
org.jets3t.service.io.ProgressMonitoredOutputStream
- All Implemented Interfaces:
- Closeable, Flushable, OutputStreamWrapper
public class ProgressMonitoredOutputStream
- extends OutputStream
- implements OutputStreamWrapper
Output stream wrapper that tracks the number of bytes that have been written through the stream.
When data is written through this stream the count of bytes is increased, and at a set minimum
interval (eg after at least 1024 bytes) a BytesProgressWatcher
implementation
is notified of the count of bytes read since the last notification.
- Author:
- James Murty
ProgressMonitoredOutputStream
public ProgressMonitoredOutputStream(OutputStream outputStream,
BytesProgressWatcher progressWatcher)
- Construts the input stream around an underlying stream and sends notification messages
to a progress watcher when bytes are read from the stream.
- Parameters:
outputStream
- the output stream to wrap, whose byte transfer count will be monitored.progressWatcher
- a watcher object that stores information about the bytes read from a stream, and
allows calculations to be perfomed using this information.
sendNotificationUpdate
public void sendNotificationUpdate(long bytesTransmitted)
- Checks how many bytes have been transferred since the last notification, and sends a notification
message if this number exceeds the minimum bytes transferred value.
- Parameters:
bytesTransmitted
-
resetProgressMonitor
public void resetProgressMonitor()
write
public void write(int b)
throws IOException
- Specified by:
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
write
public void write(byte[] b)
throws IOException
- Overrides:
write
in class OutputStream
- Throws:
IOException
close
public void close()
throws IOException
- Specified by:
close
in interface Closeable
- Overrides:
close
in class OutputStream
- Throws:
IOException
getWrappedOutputStream
public OutputStream getWrappedOutputStream()
- Specified by:
getWrappedOutputStream
in interface OutputStreamWrapper
- Returns:
- the underlying input stream wrapped by this class.