net.pandoragames.util.file

Class LineNumberIndexReader

java.lang.Object

java.io.Reader

java.io.FilterReader

net.pandoragames.util.file.LineNumberIndexReader

All Implemented Interfaces:

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

public class LineNumberIndexReader
extends java.io.FilterReader

A reader that keeps track of line breaks. The reader can return the line number of every character read previously. Recognizes '\n','\r','…','
' and '
' as line break, plus '\r' + '\n'.

Author:

Olivier Wehner

Field Summary

Fields

Modifier and Type	Field and Description
static char[]	LINEBREAKCHARS Holds the characters '\n','\r',' ',' ' and ' ' .

Fields inherited from class java.io.FilterReader

in

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor and Description
LineNumberIndexReader(java.io.Reader reader)

Method Summary

Methods

Modifier and Type	Method and Description
int	getIndex() Returns the index of the last character read, or -1 if nothing has been read so far
int	getIndexOfEndOfLine(int line) Returns the character index of the last character on the specified line.
int	getIndexOfLine(int line) Returns the character index of the first character on the specified line.
int	getLine() Returns the current line number.
int	getLine(int index) Returns the line number of the specified character position if that position has already been read.
static boolean	isLineBreakChar(int c) Returns true if the specified character is one of '\n','\r',' ',' ' or ' '.
int	read()
int	read(char[] cbuf, int off, int len)

Methods inherited from class java.io.FilterReader

close, mark, markSupported, ready, reset, skip

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

LINEBREAKCHARS

public static final char[] LINEBREAKCHARS

Holds the characters '\n','\r','…','
' and '
' .

Constructor Detail

LineNumberIndexReader

public LineNumberIndexReader(java.io.Reader reader)

Method Detail

read

public int read()
         throws java.io.IOException

Overrides:

read in class java.io.FilterReader

Throws:

java.io.IOException

read

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

Overrides:

read in class java.io.FilterReader

Throws:

java.io.IOException

getLine

public int getLine(int index)

Returns the line number of the specified character position if that position has already been read. Throws an IndexOutOfBoundsException if the specified index is negative or greater than the number of characters read so far.

Parameters:

index - character position (zero based)

Returns:

line number

Throws:

java.lang.IndexOutOfBoundsException - if index exceeds the number of characters read

getLine

public int getLine()

Returns the current line number. This is the number of lines once the entire document has been read.

Returns:

current line number

getIndex

public int getIndex()

Returns the index of the last character read, or -1 if nothing has been read so far

Returns:

index of last character read

getIndexOfLine

public int getIndexOfLine(int line)

Returns the character index of the first character on the specified line. The method returns the 0 based document index.

Parameters:

line - line number starting with 1

Returns:

index of first character on line

Throws:

java.lang.IndexOutOfBoundsException - if line parameter is smaller 1 or greater than number of lines

getIndexOfEndOfLine

public int getIndexOfEndOfLine(int line)

Returns the character index of the last character on the specified line. The method returns the 0 based document index.

Parameters:

line - line number starting with 1

Returns:

index of last character on line

Throws:

java.lang.IndexOutOfBoundsException - if line parameter is smaller 1 or greater than number of lines

isLineBreakChar

public static boolean isLineBreakChar(int c)

Returns true if the specified character is one of '\n','\r','…','
' or '
'.

Parameters:

c - to be tested

Returns:

true if line break character