Package org.jets3t.service.io
Class ProgressMonitoredOutputStream
java.lang.Object
java.io.OutputStream
org.jets3t.service.io.ProgressMonitoredOutputStream
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
,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
-
Constructor Summary
ConstructorsConstructorDescriptionProgressMonitoredOutputStream
(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. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
void
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.void
write
(byte[] b) void
write
(byte[] b, int off, int len) void
write
(int b) Methods inherited from class java.io.OutputStream
flush, nullOutputStream
-
Constructor Details
-
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.
-
-
Method Details
-
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
- Specified by:
write
in classOutputStream
- Throws:
IOException
-
write
- Overrides:
write
in classOutputStream
- Throws:
IOException
-
write
- Overrides:
write
in classOutputStream
- Throws:
IOException
-
close
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classOutputStream
- Throws:
IOException
-
getWrappedOutputStream
- Specified by:
getWrappedOutputStream
in interfaceOutputStreamWrapper
- Returns:
- the underlying input stream wrapped by this class.
-