net.scharlie.lj4l.core.io.decorator

Class CountingInputStream

java.lang.Object

java.io.InputStream

net.scharlie.lj4l.core.io.decorator.CountingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, ConnectedTestable

public final class CountingInputStream
extends InputStream
implements ConnectedTestable

This class is a decorator for input streams. It adds the ability for counting the imported bytes.

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

Constructor Summary

Constructors

Constructor and Description
CountingInputStream() Create an empty counting input stream decorator.
CountingInputStream(InputStream stream) Create a counting input stream decorator around a given input stream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
long	getCount() Get the count of all imported bytes.
boolean	isConnected() Answer whether this object is currently connected.
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	removeStream() Remove the input stream to be decorated.
void	removeStream(boolean resetCounter) Remove the input stream to be decorated.
void	setCount(long count) Set the count of all imported bytes to a given value.
void	setStream(InputStream stream) Set the input stream to be decorated or null if you want to remove the current stream.
void	setStream(InputStream stream, boolean resetCounter) Set the input stream to be decorated or null if you want to remove the current stream.
long	skip(long n)

Methods inherited from class java.io.InputStream

mark, markSupported, reset

Methods inherited from class java.lang.Object

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

Constructor Detail

CountingInputStream

public CountingInputStream()

Create an empty counting input stream decorator.

CountingInputStream

public CountingInputStream(InputStream stream)

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

Parameters:

stream - The input stream to be decorated

Method Detail

setStream

public final void setStream(InputStream stream)

Set the input 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.

Parameters:

stream - The input stream to be decorated

setStream

public final void setStream(InputStream stream,
                            boolean resetCounter)

Set the input 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 input stream to be decorated

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

removeStream

public final void removeStream()

Remove the input stream to be decorated.

The counter will not be reset.

removeStream

public final void removeStream(boolean resetCounter)

Remove the input stream to be decorated.

Parameters:

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

getCount

public final long getCount()

Get the count of all imported bytes.

Returns:

The count of imported bytes

setCount

public final void setCount(long count)

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

Parameters:

count - The count to be set

read

public final int read()

Specified by:

read in class InputStream

read

public final int read(byte[] b)

Overrides:

read in class InputStream

read

public final int read(byte[] b,
                      int off,
                      int len)

Overrides:

read in class InputStream

skip

public final long skip(long n)
                throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public final int available()

Overrides:

available in class InputStream

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 InputStream