org.jwat.common

Class CharCountingStringReader

java.lang.Object

java.io.Reader

java.io.StringReader

org.jwat.common.CharCountingStringReader

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Readable

public class CharCountingStringReader
extends java.io.StringReader

StringReader that keeps tracks of the number of consumed chars at any given time.

Author:

lbihanic, selghissassi, nicl

Field Summary

Fields

Modifier and Type	Field and Description
protected long	consumed Number of consumed bytes since the beginning of the stream.
protected long	counter Byte counter which can also be changed.

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
CharCountingStringReader(java.lang.String str) Creates a new StringReader that keeps track of consumed characters.

Method Summary

Modifier and Type	Method and Description
long	getConsumed() Consumed length getter.
long	getCounter() Retrieve the current counter value.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(char[] cbuf, int off, int len)
java.lang.String	readLine() Reads a line defined as characters read until encountering a LF or EOF.
void	reset()
void	setCounter(long bytes) Change the counter value.
long	skip(long n)

Methods inherited from class java.io.StringReader

close, ready

Methods inherited from class java.io.Reader

read, read

Methods inherited from class java.lang.Object

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

Field Detail

consumed

protected long consumed

Number of consumed bytes since the beginning of the stream.

counter

protected long counter

Byte counter which can also be changed.

Constructor Detail

CharCountingStringReader

public CharCountingStringReader(java.lang.String str)

Creates a new StringReader that keeps track of consumed characters.

Parameters:

str - Arbitrary string.

Method Detail

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.io.StringReader

mark

public void mark(int readlimit)

Overrides:

mark in class java.io.StringReader

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.io.StringReader

Throws:

java.io.IOException

getConsumed

public long getConsumed()

Consumed length getter.

Returns:

the consumed length

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

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.StringReader

Throws:

java.io.IOException

read

public int read(char[] cbuf,
                int off,
                int len)
         throws java.io.IOException

Overrides:

read in class java.io.StringReader

Throws:

java.io.IOException

skip

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

Overrides:

skip in class java.io.StringReader

Throws:

java.io.IOException

readLine

public java.lang.String readLine()
                          throws java.io.IOException

Reads a line defined as characters read until encountering a LF or EOF.

Returns:

Line read from buffered StringReader

Throws:

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