eu.cqse.check.framework.scanner

Interface IScanner

All Known Subinterfaces:

ILenientScanner

All Known Implementing Classes:

StrictScanner

public interface IScanner

Common interface for all scanners. Throws ScannerExceptions when unrecognized characters are encountered in the input.

Author:

Florian Deissenboeck

Method Summary

Modifier and Type	Method and Description
void	close() Close scanner and any underlying readers.
IToken	getNextToken() Returns the next token.
void	reset(java.io.Reader reader, java.lang.String originId) Reset the scanner.

Method Detail

getNextToken

IToken getNextToken()
             throws java.io.IOException,
                    ScannerException

Returns the next token.

Returns:

the next token. Returns ETokenType.EOF when current file is entirely scanned.

Throws:

ScannerException - Thrown upon scanner problems.

java.io.IOException - Thrown if the scanner encounters problem during file I/O.

reset

void reset(java.io.Reader reader,
           java.lang.String originId)

Reset the scanner.

Parameters:

reader - new input reader.

originId - originId

close

void close()
    throws java.io.IOException

Close scanner and any underlying readers.

Throws:

java.io.IOException - in case of an IO exception