com.dkfqs.tools.lib

Class BufferedByteCountOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

java.io.BufferedOutputStream

com.dkfqs.tools.lib.BufferedByteCountOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class BufferedByteCountOutputStream
extends java.io.BufferedOutputStream

A buffered output stream which counts the number of written bytes. Optionally, an interface can be set which is called each time when data are written to the stream.

See Also:

setCallbackInterface(BufferedByteCountOutputStreamCallbackInterface)

Constructor Summary

Constructors

Constructor and Description
BufferedByteCountOutputStream(java.io.OutputStream out) Create a new instance with a default buffer size.
BufferedByteCountOutputStream(java.io.OutputStream out, int size) Create a new instance with a specific buffer size.

Method Summary

Modifier and Type	Method and Description
long	getNumberOfWrittenBytes() Get the number of written bytes.
void	resetNumberOfWrittenBytes() Reset the number of written bytes to zero.
void	setCallbackInterface(BufferedByteCountOutputStreamCallbackInterface callbackInterface) Set or unset the callback interface.
void	write(byte[] b) Writes a byte array to this output stream.
void	write(byte[] b, int off, int len) Writes len bytes from a byte array starting at offset off to this output stream.
void	write(int b) Writes a byte to this output stream.

Methods inherited from class java.io.BufferedOutputStream

flush

Methods inherited from class java.io.FilterOutputStream

close

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedByteCountOutputStream

public BufferedByteCountOutputStream(java.io.OutputStream out)

Create a new instance with a default buffer size.

Parameters:

out - the underlying output stream

BufferedByteCountOutputStream

public BufferedByteCountOutputStream(java.io.OutputStream out,
                                     int size)

Create a new instance with a specific buffer size.

Parameters:

out - the underlying output stream

size - the buffer size

Method Detail

setCallbackInterface

public void setCallbackInterface(BufferedByteCountOutputStreamCallbackInterface callbackInterface)

Set or unset the callback interface.

Parameters:

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

write

public void write(int b)
           throws java.io.IOException

Writes a byte to this output stream.

Overrides:

write in class java.io.BufferedOutputStream

Parameters:

b - the byte

Throws:

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

write

public void write(byte[] b)
           throws java.io.IOException

Writes a byte array to this output stream.

Overrides:

write in class java.io.FilterOutputStream

Parameters:

b - the data to be written

Throws:

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

write

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

Writes len bytes from a byte array starting at offset off to this output stream.

Overrides:

write in class java.io.BufferedOutputStream

Parameters:

b - the data

off - the start offset in the data

len - the number of bytes to write

Throws:

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

getNumberOfWrittenBytes

public long getNumberOfWrittenBytes()

Get the number of written bytes.

Returns:

the number of written bytes

resetNumberOfWrittenBytes

public void resetNumberOfWrittenBytes()

Reset the number of written bytes to zero.