Package com.helger.base.io.stream

Class CountingInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

com.helger.base.io.stream.WrappedInputStream

com.helger.base.io.stream.CountingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class CountingInputStream
extends WrappedInputStream

A wrapper around an InputStream that counts the number of read bytes.

Author:

Philip Helger

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor	Description
CountingInputStream(@NonNull InputStream aSourceIS)	Constructor wrapping the given input stream.

Method Summary

Modifier and Type	Method	Description
final long	getBytesRead()
final long	getMark()
final long	getPosition()
void	mark(int nReadlimit)
int	read()
int	read(byte[] aBuf, int nOffset, int nLength)
void	reset()
long	skip(long n)
String	toString()

Methods inherited from class com.helger.base.io.stream.WrappedInputStream

getWrappedInputStream

Methods inherited from class java.io.FilterInputStream

available, close, markSupported, read

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

CountingInputStream

public CountingInputStream(@NonNull InputStream aSourceIS)

Constructor wrapping the given input stream.

Parameters:

aSourceIS - The input stream to be wrapped. May not be null.

Method Details

read

public int read()
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

read

public int read(byte[] aBuf,
 int nOffset,
 int nLength)
         throws IOException

Overrides:

read in class FilterInputStream

Throws:

IOException

skip

public long skip(@Nonnegative
 long n)
          throws IOException

Overrides:

skip in class FilterInputStream

Throws:

IOException

mark

public void mark(@Nonnegative
 int nReadlimit)

Overrides:

mark in class FilterInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class FilterInputStream

Throws:

IOException

getBytesRead

@Nonnegative
public final long getBytesRead()

Returns:

The number of read bytes.

getPosition

@Nonnegative
public final long getPosition()

Returns:

The current position in the input stream (taking skip and mark/reset into account)

getMark

@Nonnegative
public final long getMark()

Returns:

The current mark

Since:

9.3.8

toString

public String toString()

Overrides:

toString in class WrappedInputStream