org.jwat.common

Class ByteCountingInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.jwat.common.ByteCountingInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ByteCountingInputStream
extends java.io.FilterInputStream

InputStream that keeps tracks of the number of consumed bytes at any given time.

Author:

lbihanic, selghissassi, nicl

Field Summary

Fields

Modifier and Type	Field and Description
protected long	consumed Offset relative to beginning of stream.
protected long	counter Byte counter which can also be changed.
static int	READLINE_INITIAL_SIZE Read line initial size.

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
ByteCountingInputStream(java.io.InputStream in) Constructs an InputStream that counts the bytes as it reads them.

Method Summary

Modifier and Type	Method and Description
long	getConsumed() Retrieve the number of bytes consumed by this stream.
long	getCounter() Retrieve the current counter value.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset()
void	setCounter(long bytes) Change the counter value.
long	skip(long n)

Methods inherited from class java.io.FilterInputStream

available, close, read

Methods inherited from class java.lang.Object

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

Field Detail

READLINE_INITIAL_SIZE

public static final int READLINE_INITIAL_SIZE

Read line initial size.

See Also:

Constant Field Values

consumed

protected long consumed

Offset relative to beginning of stream.

counter

protected long counter

Byte counter which can also be changed.

Constructor Detail

ByteCountingInputStream

public ByteCountingInputStream(java.io.InputStream in)

Constructs an InputStream that counts the bytes as it reads them.

Parameters:

in - InputStream to wrap

Method Detail

getConsumed

public long getConsumed()

Retrieve the number of bytes consumed by this stream.

Returns:

current byte offset in this stream

setCounter

public void setCounter(long bytes)

Change the counter value. Useful for reading zero indexed relative data.

Parameters:

bytes - new counter value

getCounter

public long getCounter()

Retrieve the current counter value.

Returns:

current counter value

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.FilterInputStream

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.FilterInputStream

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.FilterInputStream

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

skip

public long skip(long n)
          throws java.io.IOException

Overrides:

skip in class java.io.FilterInputStream

Throws:

java.io.IOException