info.bioinfweb.libralign.model.utils

Class CharSequenceTokenScanner<T>

java.lang.Object

info.bioinfweb.libralign.model.utils.CharSequenceTokenScanner<T>

Type Parameters:

T - the type of token to be parsed

public class CharSequenceTokenScanner<T>
extends java.lang.Object

A scanner that can subsequently parse tokens from a character sequence consisting of concatenated token representations.

If token representations are allowed to be longer than one character, each representation must be separated by one ore more whitespace characters.

Since:

0.4.0

Author:

Ben Stöver

Constructor Summary

Constructors

Constructor and Description
CharSequenceTokenScanner(java.lang.CharSequence sequence, TokenSet<T> tokenSet, boolean allowWhitespace, T defaultToken) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Indicates whether an additional token can be parsed with the next call of next().
boolean	isDefaultTokenUsed() Indicates whether a string representation not found in the token set was replaced by the default token in any call of next() until now.
boolean	isDefaultTokenUsedNow() Indicates whether a string representation not found in the token set was replaced by the default token in the last call of next().
T	next() Returns the next token from parsed from the underlying character sequence.

Methods inherited from class java.lang.Object

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

Constructor Detail

CharSequenceTokenScanner

public CharSequenceTokenScanner(java.lang.CharSequence sequence,
                                TokenSet<T> tokenSet,
                                boolean allowWhitespace,
                                T defaultToken)

Creates a new instance of this class.

Parameters:

sequence - the sequence to parse tokens from

tokenSet - the token set containing the tokens to be parsed

allowWhitespace - Specify true here to allow whitespace between token representations or false if not. Note that specifying false will lead to a IllegalArgumentException if the specified token set contains representations longer than one character.

defaultToken - a default token to be returned if invalid token representations are found (If null is specified here, next() will throw an exception if an invalid representation is found.)

Throws:

java.lang.IllegalArgumentException - if allowWhitespace was set to false although tokenSet contains token representations that are longer than one character

Method Detail

hasNext

public boolean hasNext()

Indicates whether an additional token can be parsed with the next call of next().

Returns:

true if additional tokens can be parsed or false if the end of the underlying character sequence has been reached

next

public T next()
       throws InvalidTokenRepresentationException

Returns the next token from parsed from the underlying character sequence.

Token representations not found in the underlying token set are replaced by a default token, if one was specified. Use isDefaultTokenUsedNow() to determine whether that was the case in the last call of the method.

Returns:

the next token or null if the end of the underlying character sequence was reached.

Throws:

InvalidTokenRepresentationException - if no according token could be found for the current string representation and no default token was defined

isDefaultTokenUsedNow

public boolean isDefaultTokenUsedNow()

Indicates whether a string representation not found in the token set was replaced by the default token in the last call of next().

Returns:

true if an according replacement happened, false if no replacement needed to be done until now.

See Also:

isDefaultTokenUsed()

isDefaultTokenUsed

public boolean isDefaultTokenUsed()

Indicates whether a string representation not found in the token set was replaced by the default token in any call of next() until now.

Returns:

true if an according replacement happened, false if no replacement needed to be done until now.

See Also:

isDefaultTokenUsedNow()