TokenStreamParser (Teamscale Check Framework API)

java.lang.Object
- eu.cqse.check.framework.util.tokens.TokenStreamParser

```
public class TokenStreamParser
extends java.lang.Object
```
Allows parsing a token stream from left to right. Parser can be reset to a given position.

Constructor Summary

Constructors
Constructor and Description
`TokenStreamParser(java.util.List<IToken> tokens)` Constructor.
`TokenStreamParser(java.util.List<IToken> tokens, int startPosition)` Constructor.
`TokenStreamParser(java.util.List<IToken> tokens, java.util.Set<ETokenType> filteredTokens)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<IToken>`	`consumeAlternating(java.util.Set<ETokenType> typeSet1, java.util.Set<ETokenType> typeSet2)` Consumes tokens as long as they alternate between the two type sets.
`java.util.List<java.lang.String>`	`consumeAnyExcept(java.util.Set<ETokenType> types)` Consumes all sequential tokens that are not of the given types and returns their texts.
`java.util.List<IToken>`	`consumeAnyOf(java.util.Set<ETokenType> matchTypes)` Consumes all sequential tokens of the given types and returns the consumed tokens.
`java.util.Optional<IToken>`	`consumeOneOrZeroOf(ETokenType type)` Consumes one token of the given type and returns the token in an `Optional` or `Optional.empty()` if the current token is not of any of those types.
`java.util.Optional<IToken>`	`consumeOneOrZeroOf(java.util.Set<ETokenType> types)` Consumes one token of the given type and returns the token in an `Optional` or `Optional.empty()` if the current token is not of any of those types.
`boolean`	`continuesWithSequence(ETokenType... tokenTypes)` Returns whether the next tokens correspond to the given sequence
`java.lang.String`	`currentText()` Returns the text of the current token or `null` if all tokens have been consumed.
`IToken`	`currentToken()` Returns the current token or null iff `isDone()`.
`ETokenType`	`currentType()` Returns the type of the current token or `null` if all tokens have been consumed.
`int`	`getConsumedTokenCount()` Returns the number of tokens consumed so far.
`ELanguage`	`getTokenLanguage()` Returns the language of the given `IncludedTokens` (assuming all have the same language).
`java.util.List<IToken>`	`getTokens()`
`boolean`	`isAnyOf(java.util.Set<ETokenType> types)` Returns `true` if the current token has any of the given types.
`boolean`	`isDone()` Returns `true` if all tokens have been consumed and parsing is done.
`boolean`	`previousTokenTypeIs(ETokenType type)` Returns whether the token before the current parsing position has the given type.
`void`	`resetToPosition(int newPosition)` Reset parser position to the given token index.
`Pair<java.lang.Boolean,java.util.List<IToken>>`	`skipBalanced(ETokenType openingType, ETokenType closingType, java.util.Set<ETokenType> allowedInnerTypes)` Skips balanced braces as long as they only contain the allowed inner types.
`Pair<java.lang.Boolean,java.util.List<IToken>>`	`skipBalancedParentheses()` Syntactic sugar for skipping balanced LPAREN and RPAREN.
`void`	`skipToEnd()` Skips any remaining tokens.
`boolean`	`skipToFirstTopLevel(java.util.EnumSet<ETokenType> searchTypes, java.util.List<ETokenType> openingTypes, java.util.List<ETokenType> closingTypes)` Skips to the first occurrence of one of the given `ETokenType`s, ignoring tokens nested in pairs of the given opening/closing `ETokenType`s.
`void`	`skipToSequence(ETokenType... tokenTypes)` Skips to the beginning of the specified sequence or to the end if the sequence was not found
`java.lang.String`	`toString()`
`<T> java.util.Optional<T>`	`tryConsume(java.util.function.Function<TokenStreamParser,java.util.Optional<T>> consumer)` Tries to apply the given token consumer to this `TokenStreamParser`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TokenStreamParser
```
public TokenStreamParser(java.util.List<IToken> tokens,
                         java.util.Set<ETokenType> filteredTokens)
```
    Constructor.
    
    Parameters:
    
    tokens - The tokens to parse.
    
    filteredTokens - A set of token types. All tokens of these types are filtered out before parsing, i.e. they are simply skipped.
  - TokenStreamParser
```
public TokenStreamParser(java.util.List<IToken> tokens)
```
    Constructor.
  - TokenStreamParser
```
public TokenStreamParser(java.util.List<IToken> tokens,
                         int startPosition)
```
    Constructor.
- Method Detail
  - consumeAnyOf
```
public java.util.List<IToken> consumeAnyOf(java.util.Set<ETokenType> matchTypes)
```
    Consumes all sequential tokens of the given types and returns the consumed tokens.
  - consumeOneOrZeroOf
```
public java.util.Optional<IToken> consumeOneOrZeroOf(java.util.Set<ETokenType> types)
```
    Consumes one token of the given type and returns the token in an Optional or Optional.empty() if the current token is not of any of those types. This method only advances the parser if the current token has one of the given types.
  - consumeOneOrZeroOf
```
public java.util.Optional<IToken> consumeOneOrZeroOf(ETokenType type)
```
    Consumes one token of the given type and returns the token in an Optional or Optional.empty() if the current token is not of any of those types. This method only advances the parser if the current token has one of the given types.
  - consumeAnyExcept
```
public java.util.List<java.lang.String> consumeAnyExcept(java.util.Set<ETokenType> types)
```
    Consumes all sequential tokens that are not of the given types and returns their texts.
  - skipToFirstTopLevel
```
public boolean skipToFirstTopLevel(java.util.EnumSet<ETokenType> searchTypes,
                                   java.util.List<ETokenType> openingTypes,
                                   java.util.List<ETokenType> closingTypes)
```
    Skips to the first occurrence of one of the given ETokenTypes, ignoring tokens nested in pairs of the given opening/closing ETokenTypes. If no top-level occurrence of one of the search types is found, the parser position is left unchanged and false is returned. If an occurrence of one of the search types is found, the parser is left pointing at it and true is returned.
    
    Returns:
    
    true if the skipping succeeded and false if no top-level occurrence of the searchTypes could be found.
  - skipBalanced
```
public Pair<java.lang.Boolean,java.util.List<IToken>> skipBalanced(ETokenType openingType,
                                                                   ETokenType closingType,
                                                                   java.util.Set<ETokenType> allowedInnerTypes)
```
    Skips balanced braces as long as they only contain the allowed inner types. Checks that the current token is of the opening type. Skipping may be interrupted prematurely if unexpected tokens are encountered. In this case, the parser is left pointing to the bad token.
    
    Returns:
    
    Returns a Pair. The first element states whether this method succeeded (true if did not encounter a disallowed inner type). The second element is the list of consumed ITokens.
  - skipBalancedParentheses
```
public Pair<java.lang.Boolean,java.util.List<IToken>> skipBalancedParentheses()
```
    Syntactic sugar for skipping balanced LPAREN and RPAREN. Wraps skipBalanced(ETokenType, ETokenType, Set) with ETokenType.LPAREN and ETokenType.RPAREN.
  - consumeAlternating
```
public java.util.List<IToken> consumeAlternating(java.util.Set<ETokenType> typeSet1,
                                                 java.util.Set<ETokenType> typeSet2)
```
    Consumes tokens as long as they alternate between the two type sets.
  - isAnyOf
```
public boolean isAnyOf(java.util.Set<ETokenType> types)
```
    Returns true if the current token has any of the given types.
  - isDone
```
public boolean isDone()
```
    Returns true if all tokens have been consumed and parsing is done.
  - currentText
```
public java.lang.String currentText()
```
    Returns the text of the current token or null if all tokens have been consumed.
  - currentType
```
public ETokenType currentType()
```
    Returns the type of the current token or null if all tokens have been consumed.
  - continuesWithSequence
```
public boolean continuesWithSequence(ETokenType... tokenTypes)
```
    Returns whether the next tokens correspond to the given sequence
  - skipToSequence
```
public void skipToSequence(ETokenType... tokenTypes)
```
    Skips to the beginning of the specified sequence or to the end if the sequence was not found
  - getConsumedTokenCount
```
public int getConsumedTokenCount()
```
    Returns the number of tokens consumed so far.
  - resetToPosition
```
public void resetToPosition(int newPosition)
```
    Reset parser position to the given token index. Current position is getConsumedTokenCount().
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getTokens
```
public java.util.List<IToken> getTokens()
```
    See Also:
    
    tokens
  - tryConsume
```
public <T> java.util.Optional<T> tryConsume(java.util.function.Function<TokenStreamParser,java.util.Optional<T>> consumer)
```
    Tries to apply the given token consumer to this TokenStreamParser. If the consumer returns Optional.empty(), resets the parser to the current position and returns Optional.empty(). Otherwise, returns the return value of the consumer.
  - getTokenLanguage
```
public ELanguage getTokenLanguage()
```
    Returns the language of the given IncludedTokens (assuming all have the same language).
  - skipToEnd
```
public void skipToEnd()
```
    Skips any remaining tokens. The next call of isDone() will return true.
  - currentToken
```
public IToken currentToken()
```
    Returns the current token or null iff isDone().
  - previousTokenTypeIs
```
public boolean previousTokenTypeIs(ETokenType type)
```
    Returns whether the token before the current parsing position has the given type.

Class TokenStreamParser

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TokenStreamParser

TokenStreamParser

TokenStreamParser

Method Detail

consumeAnyOf

consumeOneOrZeroOf

consumeOneOrZeroOf

consumeAnyExcept

skipToFirstTopLevel

skipBalanced

skipBalancedParentheses

consumeAlternating

isAnyOf

isDone

currentText

currentType

continuesWithSequence

skipToSequence

getConsumedTokenCount

resetToPosition

toString

getTokens

tryConsume

getTokenLanguage

skipToEnd

currentToken

previousTokenTypeIs