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

Class Context

java.lang.Object

org.hildan.hashcode.utils.parser.context.Context

public class Context
extends java.lang.Object

Represents the current parsing context. It provides methods to access the input data and the context variables.

Constructor Summary

Constructors

Constructor	Description
Context(java.io.Reader reader, Config config)	Creates a new parsing context using the given Reader to access the input.

Method Summary

Modifier and Type	Method	Description
void	closeReader()	Releases potential resources used by the reader.
java.lang.String	getVariable(java.lang.String key)	Gets the value of the given context variable.
int	getVariableAsInt(java.lang.String key)	Gets the value of the given context variable, converted into an int.
double	readDouble()	Scans the next token of the input as a double.
int	readInt()	Scans the next token of the input as an int.
@NotNull java.lang.String	readIntoVariable(java.lang.String variableName)	Scans the next token of the input as a string and stores the value into the given variable.
java.lang.String[]	readLine()	Reads and returns the next line of input as an array of string tokens.
@NotNull java.lang.String	readString()	Scans the next token of the input as a string.
void	setVariable(java.lang.String key, java.lang.String value)	Sets the given variable to the given value.
void	skip(int n)	Skips the next n tokens of input.
InputParsingException	wrapException(java.lang.String message, java.lang.Exception cause)	Wraps the given exception into an InputParsingException.

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context(java.io.Reader reader,
               Config config)

Creates a new parsing context using the given Reader to access the input.

Parameters:

reader - the reader to use to read the input

config - the config defining how the parser should behave

Method Detail

skip

public void skip(int n)
          throws InputParsingException

Skips the next n tokens of input.

Parameters:

n - the number of tokens to skip (0 makes this method a noop)

Throws:

NoMoreLinesToReadException - if there is no more lines to read

InputParsingException - if an error occurs while reading the input

readString

@NotNull
public @NotNull java.lang.String readString()
                                     throws NoMoreLinesToReadException

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

readInt

public int readInt()
            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, or if an IO error occurs

readDouble

public double readDouble()
                  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 a double, or if an IO error occurs

readLine

public java.lang.String[] readLine()
                            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

readIntoVariable

@NotNull
public @NotNull java.lang.String readIntoVariable(java.lang.String variableName)
                                           throws NoMoreLinesToReadException

Scans the next token of the input as a string and stores the value into the given variable.

Parameters:

variableName - the name of the variable to write

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

closeReader

public void closeReader()

Releases potential resources used by the reader. Should be called when parsing is over.

Throws:

IncompleteInputReadException - if there is still some input left to read

wrapException

public InputParsingException wrapException(java.lang.String message,
                                           java.lang.Exception cause)

Wraps the given exception into an InputParsingException.

Parameters:

message - the message of the wrapped InputParsingException

cause - the exception to wrap

Returns:

a new InputParsingException with the given exception as cause

getVariable

public java.lang.String getVariable(java.lang.String key)
                             throws UndefinedVariableException

Gets the value of the given context variable.

Parameters:

key - the name of the context variable to access

Returns:

the value of the given context variable

Throws:

UndefinedVariableException - if no variable is found with the given name

getVariableAsInt

public int getVariableAsInt(java.lang.String key)
                     throws InputParsingException

Gets the value of the given context variable, converted into an int.

Parameters:

key - the name of the context variable to access

Returns:

the value of the given context variable

Throws:

UndefinedVariableException - if no variable is found with the given name

InputParsingException - if the variable value cannot be converted to an int

setVariable

public void setVariable(java.lang.String key,
                        java.lang.String value)

Sets the given variable to the given value.

Parameters:

key - the name of the context variable to create or update

value - the value to set the variable to