com.dkfqs.tools.lib

Class BufferedByteCountInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

java.io.BufferedInputStream

com.dkfqs.tools.lib.BufferedByteCountInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class BufferedByteCountInputStream
extends java.io.BufferedInputStream

A buffered input stream which counts the number of bytes read. Optionally, an interface can be set which is called each time when data are read from the stream. Additionally, throttling the throughput is also supported.

See Also:

setCallbackInterface(BufferedByteCountInputStreamCallbackInterface)

Constructor Summary

Constructors

Constructor and Description
BufferedByteCountInputStream(java.io.InputStream in) Create a new instance with a default buffer size.
BufferedByteCountInputStream(java.io.InputStream in, int size) Create a new instance with a specific buffer size.
BufferedByteCountInputStream(java.io.InputStream in, long limitThroughputBytesPerSecond, LogAdapterInterface log) Create a new instance with throttled throughput.

Method Summary

Modifier and Type	Method and Description
long	getNumberOfBytesRead() Get the number of bytes read.
long	getThroughputBytesPerSecond() Get the throughput in bytes per second.
int	read() Reads the next byte of data from this stream.
int	read(byte[] b) Reads up to byte.length bytes of data from this stream into an array of bytes.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from this stream into an array of bytes.
void	resetNumberOfBytesRead() Reset the number of bytes read to zero.
void	setCallbackInterface(BufferedByteCountInputStreamCallbackInterface callbackInterface) Set or unset the callback interface.

Methods inherited from class java.io.BufferedInputStream

available, close, mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedByteCountInputStream

public BufferedByteCountInputStream(java.io.InputStream in)

Create a new instance with a default buffer size.

Parameters:

in - the underlying input stream

BufferedByteCountInputStream

public BufferedByteCountInputStream(java.io.InputStream in,
                                    int size)

Create a new instance with a specific buffer size.

Parameters:

in - the underlying input stream

size - the buffer size

BufferedByteCountInputStream

public BufferedByteCountInputStream(java.io.InputStream in,
                                    long limitThroughputBytesPerSecond,
                                    LogAdapterInterface log)

Create a new instance with throttled throughput.

Parameters:

in - the underlying input stream

limitThroughputBytesPerSecond - the limited throughput in bytes per second

log - the HTTP client log adapter

Method Detail

setCallbackInterface

public void setCallbackInterface(BufferedByteCountInputStreamCallbackInterface callbackInterface)

Set or unset the callback interface.

Parameters:

callbackInterface - the callback interface to set, or null to unset the callback interface

read

public int read()
         throws java.io.IOException

Reads the next byte of data from this stream.

Overrides:

read in class java.io.BufferedInputStream

Returns:

the next byte of data, or -1 if the end of the stream is reached

Throws:

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

read

public int read(byte[] b)
         throws java.io.IOException

Reads up to byte.length bytes of data from this stream into an array of bytes.

Overrides:

read in class java.io.FilterInputStream

Parameters:

b - the buffer into which the data is read

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

Throws:

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

read

public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException

Reads up to len bytes of data from this stream into an array of bytes.

Overrides:

read in class java.io.BufferedInputStream

Parameters:

b - the buffer into which the data is read

off - the start offset in the buffer

len - the maximum number of bytes read

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

Throws:

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

getNumberOfBytesRead

public long getNumberOfBytesRead()

Get the number of bytes read.

Returns:

the number of bytes read.

resetNumberOfBytesRead

public void resetNumberOfBytesRead()

Reset the number of bytes read to zero.

getThroughputBytesPerSecond

public long getThroughputBytesPerSecond()

Get the throughput in bytes per second.

Returns:

the throughput in bytes per second, or -1 if no such value is available