Package org.jets3t.service.io
Class ProgressMonitoredInputStream
java.lang.Object
java.io.InputStream
org.jets3t.service.io.ProgressMonitoredInputStream
- All Implemented Interfaces:
Closeable,AutoCloseable,InputStreamWrapper
Input stream wrapper that tracks the number of bytes that have been read through the stream.
When data is read through this stream the count of bytes is increased and the associated
BytesProgressWatcher object is notified of the count of bytes read.- Author:
- James Murty
-
Constructor Summary
ConstructorsConstructorDescriptionProgressMonitoredInputStream(InputStream inputStream, 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 TypeMethodDescriptionintvoidclose()intread()intread(byte[] b) intread(byte[] b, int off, int len) voidvoidsendNotificationUpdate(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.Methods inherited from class java.io.InputStream
mark, markSupported, nullInputStream, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo
-
Constructor Details
-
ProgressMonitoredInputStream
Construts the input stream around an underlying stream and sends notification messages to a progress watcher when bytes are read from the stream.- Parameters:
inputStream- the input 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() -
read
- Specified by:
readin classInputStream- Throws:
IOException
-
read
- Overrides:
readin classInputStream- Throws:
IOException
-
read
- Overrides:
readin classInputStream- Throws:
IOException
-
available
- Overrides:
availablein classInputStream- Throws:
IOException
-
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Overrides:
closein classInputStream- Throws:
IOException
-
getWrappedInputStream
- Specified by:
getWrappedInputStreamin interfaceInputStreamWrapper- Returns:
- the underlying input stream wrapped by this class.
-