org.kocakosm.pitaya.io

Class CountingReader

java.lang.Object

java.io.Reader

org.kocakosm.pitaya.io.CountingReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public final class CountingReader
extends Reader

A decorating Reader that counts the number of characters that have been read from its underlying Reader. Characters read multiple times are counted as many times as they have been read. Skipped characters are not counted.

Author:

Osman KOCAK

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
CountingReader(Reader reader) Creates a new CountingReader.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
long	getCount() Returns the number of characters that have been read from the underlying stream so far.
void	mark(int readLimit)
boolean	markSupported()
int	read()
int	read(char[] buf)
int	read(char[] buf, int off, int len)
boolean	ready()
void	reset()
long	resetCount() Sets the counter to 0 and returns its value before resetting it.
long	skip(long n)

Methods inherited from class java.io.Reader

read

Methods inherited from class java.lang.Object

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

Constructor Detail

CountingReader

public CountingReader(Reader reader)

Creates a new CountingReader.

Parameters:

reader - the underlying reader.

Throws:

NullPointerException - if reader is null.

Method Detail

getCount

public long getCount()

Returns the number of characters that have been read from the underlying stream so far.

Returns:

the number of characters that have been read so far.

resetCount

public long resetCount()

Sets the counter to 0 and returns its value before resetting it.

Returns:

the number of characters that have been read so far.

ready

public boolean ready()
              throws IOException

Overrides:

ready in class Reader

Throws:

IOException

read

public int read()
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

read

public int read(char[] buf)
         throws IOException

Overrides:

read in class Reader

Throws:

IOException

read

public int read(char[] buf,
       int off,
       int len)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class Reader

mark

public void mark(int readLimit)
          throws IOException

Overrides:

mark in class Reader

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class Reader

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class Reader

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Reader

Throws:

IOException