de.unkrig.commons.text.scanner

Class AbstractScanner<TT extends Enum<TT>>

java.lang.Object

de.unkrig.commons.text.scanner.AbstractScanner<TT>

Type Parameters:

TT - Enumerates the scanner-specific token types

All Implemented Interfaces:

ProducerWhichThrows<AbstractScanner.Token<TT>,ScanException>, StringScanner<TT>

Direct Known Subclasses:

StatefulScanner, StatelessScanner

public abstract class AbstractScanner<TT extends Enum<TT>>
extends Object
implements StringScanner<TT>

A scanner that produces AbstractScanner.Tokens.

See Also:

StringScanner.produce()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractScanner.Token<TT extends Enum<TT>> Representation of a scanned token.

Field Summary

Fields

Modifier and Type	Field and Description
protected CharSequence	cs The string currently being scanned; typically one line from an input document.
protected int	offset The position within cs of the next token to be scanned.
protected int	previousTokenOffset The position within cs of the previously scanned token.

Constructor Summary

Constructors

Constructor and Description
AbstractScanner()

Method Summary

Modifier and Type	Method and Description
int	getOffset()
int	getPreviousTokenOffset()
AbstractScanner<TT>	setInput(CharSequence cs)
ProducerWhichThrows<AbstractScanner.Token<TT>,ScanException>	suppress(Collection<TT> suppressedTokenTypes) Creates and returns a producer which skips tokens of the suppressedTokenTypes.
ProducerWhichThrows<AbstractScanner.Token<TT>,ScanException>	suppress(TT suppressedTokenType) Creates and returns a producer which skips tokens of the suppressedTokenType.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.unkrig.commons.text.scanner.StringScanner

produce

Field Detail

cs

protected CharSequence cs

The string currently being scanned; typically one line from an input document.

offset

protected int offset

The position within cs of the next token to be scanned.

previousTokenOffset

protected int previousTokenOffset

The position within cs of the previously scanned token.

Constructor Detail

AbstractScanner

public AbstractScanner()

Method Detail

setInput

public AbstractScanner<TT> setInput(CharSequence cs)

Specified by:

setInput in interface StringScanner<TT extends Enum<TT>>

Parameters:

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

Returns:

This scanner

getOffset

public int getOffset()

Specified by:

getOffset in interface StringScanner<TT extends Enum<TT>>

Returns:

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

getPreviousTokenOffset

public int getPreviousTokenOffset()

Specified by:

getPreviousTokenOffset in interface StringScanner<TT extends Enum<TT>>

Returns:

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

suppress

public ProducerWhichThrows<AbstractScanner.Token<TT>,ScanException> suppress(TT suppressedTokenType)

Creates and returns a producer which skips tokens of the suppressedTokenType.

suppress

public ProducerWhichThrows<AbstractScanner.Token<TT>,ScanException> suppress(Collection<TT> suppressedTokenTypes)

Creates and returns a producer which skips tokens of the suppressedTokenTypes.

toString

public String toString()

Specified by:

toString in interface ProducerWhichThrows<AbstractScanner.Token<TT extends Enum<TT>>,ScanException>

Overrides:

toString in class Object