Package org.hildan.hashcode.utils.parser.context

Class LineNumberScanner

java.lang.Object

org.hildan.hashcode.utils.parser.context.LineNumberScanner

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class LineNumberScanner
extends java.lang.Object
implements java.io.Closeable, java.lang.AutoCloseable

A scanner that is aware of the line numbers and throws exceptions that contain this useful piece of information.

Constructor Summary

Constructors

Constructor	Description
LineNumberScanner(java.io.Reader reader, java.lang.String delimiter)	Creates a new LineNumberScanner using the given reader as underlying source.

Method Summary

Modifier and Type	Method	Description
void	close()
@Nullable java.lang.String	getCurrentLine()	Gets the full line containing the last token read.
int	getLineNumber()	Gets the line number of the last token read.
double	nextDouble()	Scans the next token of the input as a double.
int	nextInt()	Scans the next token of the input as an int.
java.lang.String	nextLine()	Reads and returns the next line of input.
java.lang.String[]	nextLineTokens()	Reads and returns the next line of input as an array of string tokens.
java.lang.String	nextString()	Scans the next token of the input as a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

LineNumberScanner

public LineNumberScanner(java.io.Reader reader,
                         java.lang.String delimiter)

Creates a new LineNumberScanner using the given reader as underlying source.

Parameters:

reader - the reader to read the data from

delimiter - the delimiter to use to identify separate tokens

Method Detail

getLineNumber

public int getLineNumber()

Gets the line number of the last token read. If no token has been read yet, the line number is 0. Then the line numbering is 1-based.

Note that this method does not move the scanner or consume any input.

Returns:

the line number of the last token seen

getCurrentLine

@Nullable
public @Nullable java.lang.String getCurrentLine()

Gets the full line containing the last token read. If no token has been read yet, the current line is null. Even if the last token read is in the middle of the line, the full line is returned from beginning to end.

Note that this method does not move the scanner or consume any input.

Returns:

the current line as a string

nextString

public java.lang.String nextString()
                            throws InputParsingException

Scans the next token of the input as a string.

Returns:

the string scanned from the input

Throws:

NoMoreLinesToReadException - if there is no more lines to read

InputParsingException - if an error occurs while reading the input

nextInt

public int nextInt()
            throws InputParsingException

Scans the next token of the input as an int.

Returns:

the int scanned from the input

Throws:

NoMoreLinesToReadException - if there is no more lines to read

InputParsingException - if the input could not be parsed as an int

nextDouble

public double nextDouble()
                  throws InputParsingException

Scans the next token of the input as a double.

Returns:

the double scanned from the input

Throws:

NoMoreLinesToReadException - if there is no more lines to read

InputParsingException - if the input could not be parsed as an int

nextLine

public java.lang.String nextLine()
                          throws InputParsingException

Reads and returns the next line of input.

Returns:

the next line of input

Throws:

IncompleteLineReadException - if the previous line was not completely consumed

NoMoreLinesToReadException - if there is no more lines to read

InputParsingException - if an error occurs while reading the input

nextLineTokens

public java.lang.String[] nextLineTokens()
                                  throws InputParsingException

Reads and returns the next line of input as an array of string tokens.

Returns:

the next line of input

Throws:

IncompleteLineReadException - if the previous line was not completely consumed

NoMoreLinesToReadException - if there is no more lines to read

InputParsingException - if an error occurs while reading the input

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable