eu.cqse.check.framework.scanner

Class ScannerFactory

java.lang.Object

eu.cqse.check.framework.scanner.ScannerFactory

public class ScannerFactory
extends java.lang.Object

This factory class is the central access point to the scanner framework. It offers different methods for constructing strict and lenient scanners for different languages and different input formats.

Every scanner is associated with an origin id that is attached to every token created by this scanner. It identifies the resource the tokens stem from. However, the factory does not interpret the content of the originId but merely passes it on to the scanners (and thus ultimately to the tokens). The caller of the factory methods in this class thus needs to make sure that the originIds are sane. This factory can construct strict scanners (interface IScanner) and lenient scanners (interface ILenientScanner). Strict scanners throw ScannerExceptions if they encounter input they cannot recognize. Lenient scanners do not throw ScannerExceptions, but instead return tokens with a token type of token class ETokenType.ETokenClass.ERROR, specifying the type of error encountered, and resume scanning.

Method Summary

Modifier and Type	Method and Description
static ILenientScanner	newLenientScanner(ELanguage language, java.io.File file) Create a new lenient scanner for a file.
static ILenientScanner	newLenientScanner(ELanguage language, java.io.Reader reader, java.lang.String originId) Create a new lenient scanner that uses the specified reader.
static ILenientScanner	newLenientScanner(ELanguage language, java.lang.String input, java.lang.String originId) Create a new lenient scanner that scans a string.
static IScanner	newScanner(ELanguage language, java.io.File file) Create a new strict scanner for a file.
static IScanner	newScanner(ELanguage language, java.io.Reader reader, java.lang.String originId) Create a new strict scanner that uses the specified reader.
static IScanner	newScanner(ELanguage language, java.lang.String input, java.lang.String originId) Create a new strict scanner that scans a string.
static IScanner	strict(ILenientScanner scanner) Wraps an ILenientScanner scanner with a StrictScanner.

Methods inherited from class java.lang.Object

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

Method Detail

newScanner

public static IScanner newScanner(ELanguage language,
                                  java.io.File file)
                           throws java.io.IOException

Create a new strict scanner for a file. Tokens generated by this scanner will carry the canonical path of the file as origin id.

Parameters:

language - implementation language

file - the file to scan

Returns:

a new strict scanner

Throws:

java.io.IOException

newLenientScanner

public static ILenientScanner newLenientScanner(ELanguage language,
                                                java.io.File file)
                                         throws java.io.IOException

Create a new lenient scanner for a file. Tokens generated by this scanner will carry the canonical path of the file as originId.

Parameters:

language - implementation language

file - the file to scan

Returns:

a new lenient scanner

Throws:

java.io.IOException

newScanner

public static IScanner newScanner(ELanguage language,
                                  java.lang.String input,
                                  java.lang.String originId)

Create a new strict scanner that scans a string.

Parameters:

language - implementation language

input - the string to scan

originId - origin id that denotes the resource the tokens stem from

Returns:

a new strict scanner

newLenientScanner

public static ILenientScanner newLenientScanner(ELanguage language,
                                                java.lang.String input,
                                                java.lang.String originId)

Create a new lenient scanner that scans a string.

Parameters:

language - implementation language

input - the string to scan

originId - origin id that denotes the resource the tokens stem from

Returns:

a new lenient scanner

newScanner

public static IScanner newScanner(ELanguage language,
                                  java.io.Reader reader,
                                  java.lang.String originId)

Create a new strict scanner that uses the specified reader.

Parameters:

language - implementation language

reader - the reader to read the input from

originId - origin id that denotes the resource the tokens stem from

Returns:

a new strict scanner

newLenientScanner

public static ILenientScanner newLenientScanner(ELanguage language,
                                                java.io.Reader reader,
                                                java.lang.String originId)

Create a new lenient scanner that uses the specified reader.

Parameters:

language - implementation language

reader - the reader to read the input from

originId - origin id that denotes the resource the tokens stem from

Returns:

a new lenient scanner

strict

public static IScanner strict(ILenientScanner scanner)

Wraps an ILenientScanner scanner with a StrictScanner.