eu.cqse.check.framework.shallowparser

Class NestingAwareTokenIterator

java.lang.Object

eu.cqse.check.framework.shallowparser.NestingAwareTokenIterator

All Implemented Interfaces:

java.util.Iterator<IToken>

public class NestingAwareTokenIterator
extends java.lang.Object
implements java.util.Iterator<IToken>

Iterator over a token list that keeps track of nesting.

Constructor Summary

Constructors

Constructor and Description
NestingAwareTokenIterator(java.util.List<IToken> tokens, int startPosition, java.util.List<ETokenType> openingTypes, java.util.List<ETokenType> closingTypes) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getCurrentIndex() Returns the index of the current token, i.e.
int	getNestingDepth() Returns the depth of the current nesting.
boolean	hasNext()
boolean	isTopLevel() Returns true if the last token returned by next() is a top-level token.
IToken	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

NestingAwareTokenIterator

public NestingAwareTokenIterator(java.util.List<IToken> tokens,
                                 int startPosition,
                                 java.util.List<ETokenType> openingTypes,
                                 java.util.List<ETokenType> closingTypes)

Constructor.

Parameters:

tokens - the stream over which to iterate.

startPosition - the index of the first token that should be returned by the iterator.

openingTypes - the list of tokens that open an new nesting level.

closingTypes - the list of tokens that close a nesting level. Each entry must correspond to the entry of openingTypes at the same position.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<IToken>

next

public IToken next()

Specified by:

next in interface java.util.Iterator<IToken>

isTopLevel

public boolean isTopLevel()

Returns true if the last token returned by next() is a top-level token. Opening/closing tokens are never top-level. In case opening/closing tokens are not balanced, returns true for superfluous closing tokens and tokens thereafter.

getNestingDepth

public int getNestingDepth()

Returns the depth of the current nesting. Opening/closing tokens are reported as the nesting level they introduce. In case opening/closing tokens are not balanced, returns negative numbers for superfluous closing tokens and tokens thereafter.

getCurrentIndex

public int getCurrentIndex()

Returns the index of the current token, i.e. the token returned by the last call to next(). The result of this method is thus only valid if you called next() at least once.

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<IToken>