net.scharlie.lj4l.core.io.decorator

Class CountingOutputStream

java.lang.Object

java.io.OutputStream

net.scharlie.lj4l.core.io.decorator.CountingOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, ConnectedTestable

public final class CountingOutputStream
extends OutputStream
implements ConnectedTestable

This class is a decorator for output streams. It adds the ability for counting the exported bytes.

Instances of this class are not safe for use by multiple threads.

Constructor Summary

Constructors

Constructor and Description
CountingOutputStream() Create an empty counting output stream decorator.
CountingOutputStream(OutputStream stream) Create a counting output stream decorator around a given output stream.

Method Summary

Modifier and Type	Method and Description
void	clearDisconnectedBuffer() Remove all buffered and therefore not yet written bytes from the internal disconnected buffer.
void	close()
void	flush()
long	getCount() Get the count of all exported bytes.
boolean	isConnected() Answer whether this object is currently connected.
void	removeStream() Remove the output stream to be decorated.
void	removeStream(boolean resetCounter, boolean clearBuffer) Remove the output stream to be decorated.
void	setCount(long count) Set the count of all exported bytes to a given value.
void	setStream(OutputStream stream) Set the output stream to be decorated or null if you want to remove the current stream.
void	setStream(OutputStream stream, boolean resetCounter, boolean clearBuffer) Set the output stream to be decorated or null if you want to remove the current stream.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

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

Constructor Detail

CountingOutputStream

public CountingOutputStream()

Create an empty counting output stream decorator.

CountingOutputStream

public CountingOutputStream(OutputStream stream)

Create a counting output stream decorator around a given output stream.

Parameters:

stream - The output stream to be decorated

Method Detail

setStream

public final void setStream(OutputStream stream)

Set the output stream to be decorated or null if you want to remove the current stream.

An already existing stream will be removed before.

The counter will not be reset and the internal disconnected buffer will not be cleared.

Parameters:

stream - The output stream to be decorated

setStream

public final void setStream(OutputStream stream,
                            boolean resetCounter,
                            boolean clearBuffer)

Set the output stream to be decorated or null if you want to remove the current stream.

An already existing stream will be removed before.

Parameters:

stream - The output stream to be decorated

resetCounter - Flag whether the counter has to be reset to zero

clearBuffer - Flag whether to remove all buffered and therefore not yet written bytes from the internal disconnected buffer

removeStream

public final void removeStream()

Remove the output stream to be decorated.

The counter will not be reset and the internal disconnected buffer will not be cleared.

removeStream

public final void removeStream(boolean resetCounter,
                               boolean clearBuffer)

Remove the output stream to be decorated.

Parameters:

resetCounter - Flag whether the counter has to be reset to zero

clearBuffer - Flag whether to remove all buffered and therefore not yet written bytes from the internal disconnected buffer

getCount

public final long getCount()

Get the count of all exported bytes.

Returns:

The count of exported bytes

setCount

public final void setCount(long count)

Set the count of all exported bytes to a given value.

Parameters:

count - The count to be set

clearDisconnectedBuffer

public final void clearDisconnectedBuffer()

Remove all buffered and therefore not yet written bytes from the internal disconnected buffer.

write

public final void write(int b)
                 throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public final void write(byte[] b)
                 throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public final void write(byte[] b,
                        int off,
                        int len)
                 throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public final void flush()
                 throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

isConnected

public final boolean isConnected()

Description copied from interface: ConnectedTestable

Answer whether this object is currently connected.

Specified by:

isConnected in interface ConnectedTestable

Returns:

answer

close

public final void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream