eu.cqse.check.framework.scanner

Class ScannerUtils

java.lang.Object

eu.cqse.check.framework.scanner.ScannerUtils

public class ScannerUtils
extends java.lang.Object

This class offers utility methods for scanners.

Author:

Florian Deissenboeck, Elmar Juergens

Constructor Summary

Constructors

Constructor and Description
ScannerUtils()

Method Summary

Modifier and Type	Method and Description
static java.util.List<IToken>	getTokens(java.lang.String content, ELanguage language) Returns the results of scanning a string.
static java.util.List<IToken>	getTokens(java.lang.String content, ELanguage language, java.lang.String origin) Returns the results of scanning a string.
static java.util.List<IToken>	readTokens(ILenientScanner scanner) Read tokens from a lenient scanner and store them in a list.
static void	readTokens(IScanner scanner, java.util.List<IToken> tokens, java.util.List<ScannerException> exceptions) Read tokens from a strict scanner and store them in a list.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScannerUtils

public ScannerUtils()

Method Detail

readTokens

public static void readTokens(IScanner scanner,
                              java.util.List<IToken> tokens,
                              java.util.List<ScannerException> exceptions)
                       throws java.io.IOException

Read tokens from a strict scanner and store them in a list. This expects the scanner to return a token with type ETokenType.EOF at the end of the file. This last token will not be added to the list of tokens.

Parameters:

scanner - the scanner to read from

tokens - the list to store tokens

exceptions - another list to store possible exceptions that occurred during scanning.

Throws:

java.io.IOException - thrown if scanner throws an IO exception

readTokens

public static java.util.List<IToken> readTokens(ILenientScanner scanner)
                                         throws java.io.IOException

Read tokens from a lenient scanner and store them in a list. This expects the scanner to return a token with type ETokenType.EOF at the end of the file. This last token will not be added to the list of tokens.

Parameters:

scanner - the scanner to read from

Throws:

java.io.IOException - thrown if scanner throws an IO exception

getTokens

public static java.util.List<IToken> getTokens(java.lang.String content,
                                               ELanguage language)

Returns the results of scanning a string. The origin of the tokens is set to some arbitrary value.

getTokens

public static java.util.List<IToken> getTokens(java.lang.String content,
                                               ELanguage language,
                                               java.lang.String origin)

Returns the results of scanning a string. The origin of the tokens is set to the given origin.