eu.cqse.check.framework.util.tokens

Class TokenStream

java.lang.Object

eu.cqse.check.framework.util.tokens.TokenStream

public class TokenStream
extends java.lang.Object

Wraps a list of tokens for easier parsing.

Constructor Summary

Constructors

Constructor and Description
TokenStream(java.util.List<IToken> tokens, int position) Constructor.

Method Summary

Modifier and Type	Method and Description
void	advancePosition(int increment) Advances the position of the stream by the given increment.
int	getPosition() Returns the current position in the stream.
java.util.List<IToken>	getTokens()
java.util.List<IToken>	getTokensSince(int startPosition) Returns a view of the tokens in between the given position (inclusive) and the current position (exclusive).
boolean	isAtBeginning() Returns true if the steam is positioned on the first token.
boolean	isExhausted() Returns true if the stream is positioned past the last token.
IToken	moveBack() Moves the stream's position back by one token and returns the token at that position or null if the stream was already at the beginning.
IToken	next() Advances the stream by one token.
IToken	peekBackward() Returns the token before the current one or null if the stream is at the beginning.
IToken	peekCurrent() Returns the current token or null if the stream is exhausted.
void	setPosition(int position) Sets the position of the stream to the given one.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenStream

public TokenStream(java.util.List<IToken> tokens,
                   int position)

Constructor.

Method Detail

getTokens

public java.util.List<IToken> getTokens()

See Also:

tokens

setPosition

public void setPosition(int position)

Sets the position of the stream to the given one.

advancePosition

public void advancePosition(int increment)

Advances the position of the stream by the given increment.

isAtBeginning

public boolean isAtBeginning()

Returns true if the steam is positioned on the first token.

isExhausted

public boolean isExhausted()

Returns true if the stream is positioned past the last token.

getTokensSince

public java.util.List<IToken> getTokensSince(int startPosition)

Returns a view of the tokens in between the given position (inclusive) and the current position (exclusive).

next

public IToken next()

Advances the stream by one token.

Returns:

The token the stream was positioned on before advancing or null if the stream was already exhausted at that time.

peekBackward

public IToken peekBackward()

Returns the token before the current one or null if the stream is at the beginning.

peekCurrent

public IToken peekCurrent()

Returns the current token or null if the stream is exhausted.

getPosition

public int getPosition()

Returns the current position in the stream. May be used to reset the stream to that position at a later time using setPosition(int).

moveBack

public IToken moveBack()

Moves the stream's position back by one token and returns the token at that position or null if the stream was already at the beginning.