org.dbrain.data.parsing

Class TokenParser

java.lang.Object

org.dbrain.data.parsing.TokenParser

All Implemented Interfaces:

AutoCloseable

public class TokenParser
extends Object
implements AutoCloseable

This class allow sequential parsing of text stream to extract tokens.

Version:

1.0

Author:

Eric Poitras

See Also:

for more informations on availables tokens.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ERR_EXPECTED_NUMERIC
static String	ERR_EXPECTED_TOKEN
static String	ERR_EXPECTING_EOF
static String	ERR_INVALID_CHARACTER
static String	ERR_READER_NULL
static String	ERR_UNEXPECTED_EOS
static String	ERR_WRONG_QUOTE

Constructor Summary

Constructors

Constructor and Description
TokenParser(Reader aReader) Create a new Parser.
TokenParser(String s) Create a new Parser having a string as it's source.

Method Summary

Modifier and Type	Method and Description
void	close() Close the underlying stream.
boolean	consume() Used to invalidate current token getValue and set the parsed flag to false, firing the parsing of a new token from the stream.
Object	get(Token expectedToken1)
Object	get(Token expectedToken1, Token expectedToken2)
Object	get(Token expectedToken1, Token expectedToken2, Token expectedToken3)
String	getIdentifier() Read the identifier getValue from the parser.
String	getKeyword() Read the keyword from the parser.
Number	getNumeric() Read the numeric getValue from the parser.
String	getString() Read the string getValue from the parser.
Token	getToken() Get the available token in the stream.
Token	getValidToken(Token expectedToken1)
Token	getValidToken(Token expectedToken1, Token expectedToken2)
Token	getValidToken(Token expectedToken1, Token expectedToken2, Token expectedToken3)
boolean	isToken(Token validToken1)
boolean	isToken(Token validToken1, Token validToken2)
boolean	isToken(Token validToken1, Token validToken2, Token validToken3)
void	raiseError(String msg) Throw a ParseException.
void	raiseExpectedTokenError(Token foundToken, Token... expectedTokens)
Object	read(Token expectedToken1)
Object	read(Token expectedToken1, Token expectedToken2)
Object	read(Token expectedToken1, Token expectedToken2, Token expectedToken3)
String	readIdentifier() Read the identifier getValue from the parser.
String	readKeyword() Read the keyword from the parser.
Number	readNumeric() Read the numeric getValue from the parser.
String	readString() Read the string getValue from the parser.

Methods inherited from class java.lang.Object

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

Field Detail

ERR_READER_NULL

public static String ERR_READER_NULL

ERR_INVALID_CHARACTER

public static String ERR_INVALID_CHARACTER

ERR_UNEXPECTED_EOS

public static String ERR_UNEXPECTED_EOS

ERR_EXPECTED_NUMERIC

public static String ERR_EXPECTED_NUMERIC

ERR_EXPECTED_TOKEN

public static String ERR_EXPECTED_TOKEN

ERR_WRONG_QUOTE

public static String ERR_WRONG_QUOTE

ERR_EXPECTING_EOF

public static String ERR_EXPECTING_EOF

Constructor Detail

TokenParser

public TokenParser(Reader aReader)

Create a new Parser.

Parameters:

aReader - The source of the text stream.

Since:

1.0

TokenParser

public TokenParser(String s)

Create a new Parser having a string as it's source.

Parameters:

s - The source of the text stream.

Method Detail

raiseError

public void raiseError(String msg)

Throw a ParseException.

Parameters:

msg - The message to include in the error.

Since:

1.0

raiseExpectedTokenError

public void raiseExpectedTokenError(Token foundToken,
                                    Token... expectedTokens)

getToken

public Token getToken()

Get the available token in the stream. This method does *NOT* consume the token.

Returns:

the token.

isToken

public boolean isToken(Token validToken1)

isToken

public boolean isToken(Token validToken1,
                       Token validToken2)

isToken

public boolean isToken(Token validToken1,
                       Token validToken2,
                       Token validToken3)

getValidToken

public Token getValidToken(Token expectedToken1)

getValidToken

public Token getValidToken(Token expectedToken1,
                           Token expectedToken2)

getValidToken

public Token getValidToken(Token expectedToken1,
                           Token expectedToken2,
                           Token expectedToken3)

getNumeric

public Number getNumeric()

Read the numeric getValue from the parser.

Returns:

the current numeric getValue.

Throws:

ParseException - if current token is not numeric.

readNumeric

public Number readNumeric()

Read the numeric getValue from the parser.

Move the parser on the next token.

Returns:

the current numeric getValue.

Throws:

ParseException - if current token is not numeric.

getKeyword

public String getKeyword()

Read the keyword from the parser.

Returns:

the current keyword.

Throws:

ParseException - if current token is not a keyword.

readKeyword

public String readKeyword()

Read the keyword from the parser.

Move the parser on the next token.

Returns:

the current string getValue.

Throws:

ParseException - if current token is not a keyword.

getIdentifier

public String getIdentifier()

Read the identifier getValue from the parser.

Returns:

the current identifier getValue.

Throws:

ParseException - if current token is not string.

readIdentifier

public String readIdentifier()

Read the identifier getValue from the parser.

Move the parser on the next token.

Returns:

the current string getValue.

Throws:

ParseException - if current token is not string.

getString

public String getString()

Read the string getValue from the parser.

Does not care about the quoting of the string.

Returns:

the current string getValue.

Throws:

ParseException - if current token is not string.

readString

public String readString()

Read the string getValue from the parser.

Does not care about the quoting of the string.

Move the parser on the next token.

Returns:

the current string getValue.

Throws:

ParseException - if current token is not string.

get

public Object get(Token expectedToken1)

get

public Object get(Token expectedToken1,
                  Token expectedToken2)

get

public Object get(Token expectedToken1,
                  Token expectedToken2,
                  Token expectedToken3)

read

public Object read(Token expectedToken1)

read

public Object read(Token expectedToken1,
                   Token expectedToken2)

read

public Object read(Token expectedToken1,
                   Token expectedToken2,
                   Token expectedToken3)

consume

public boolean consume()

Used to invalidate current token getValue and set the parsed flag to false, firing the parsing of a new token from the stream.

close

public void close()

Close the underlying stream.

Specified by:

close in interface AutoCloseable