de.unkrig.commons.text.scanner

Interface StringScanner<TT extends java.lang.Enum<TT>>

Type Parameters:

TT - Defines the token types that this scanner will produce

All Superinterfaces:

ProducerWhichThrows<AbstractScanner.Token<TT>,ScanException>

All Known Implementing Classes:

AbstractScanner, StatefulScanner, StatelessScanner

public interface StringScanner<TT extends java.lang.Enum<TT>>
extends ProducerWhichThrows<AbstractScanner.Token<TT>,ScanException>

A scanner which has a notion of an 'offset' where the previously scanned token starts.

See Also:

produce()

Method Summary

Modifier and Type	Method and Description
int	getOffset()
int	getPreviousTokenOffset()
AbstractScanner.Token<TT>	produce() Before setInput(CharSequence) is called, this method returns null.
StringScanner<TT>	setInput(java.lang.CharSequence cs)

Methods inherited from interface de.unkrig.commons.lang.protocol.ProducerWhichThrows

toString

Method Detail

setInput

StringScanner<TT> setInput(java.lang.CharSequence cs)

Parameters:

cs - The CharSequence from which following calls to produce() will scan tokens

Returns:

This scanner

produce

@Nullable
AbstractScanner.Token<TT> produce()
                                      throws ScanException

Before setInput(CharSequence) is called, this method returns null. After setInput(CharSequence) was called, this method breaks the input char character sequence up into tokens and returns them one by one. When the input char sequence is exhausted, null is returned until setInput(CharSequence) is called again.

Specified by:

produce in interface ProducerWhichThrows<AbstractScanner.Token<TT extends java.lang.Enum<TT>>,ScanException>

Throws:

ScanException

getOffset

int getOffset()

Returns:

The offset within the input string set through setInput(CharSequence) where the previously scanned token ends, or 0 after the call to setInput(CharSequence) and before the first call to produce()

getPreviousTokenOffset

int getPreviousTokenOffset()

Returns:

The offset within the input string set through setInput(CharSequence) where the previously scanned token begins, or -1 after the call to setInput(CharSequence) and before the first call to produce()