scanner

Class Scanner

java.lang.Object

scanner.Scanner

Direct Known Subclasses:

AssignmentFileScanner, DefinitionFileScanner, PackageDescriptionFileScanner, TypeFileScanner

public abstract class Scanner
extends java.lang.Object

This interface represents the Scanner.

Author:

HFW410

Field Summary

Fields

Modifier and Type	Field and Description
private Buffer<AbstractSymbol>	buffer This attribute represents a buffer of Symbols.
private java.lang.Integer	columnCounter This attributer representes the counter for the columns to show columnnumbers.
private java.lang.String	currentExpression This attribute represents the currentExpression as String.
private java.lang.Integer	rowCounter This attribute represents the counter for the rows to show rownumbers.

Constructor Summary

Constructors

Constructor and Description
Scanner(Buffer<AbstractSymbol> buffer) This is the constructoer to set the attributes.

Method Summary

Modifier and Type	Method and Description
private Buffer<AbstractSymbol>	getBuffer()
protected java.lang.Integer	getColumnCounter()
private java.lang.String	getCurrentExpression()
protected abstract AbstractState	getRestState(java.lang.Integer beginningRow, java.lang.Integer beginningColumn)
protected java.lang.Integer	getRowCounter()
protected abstract AbstractState	getSelectionState()
protected void	handleRowEnd() this method increase the RowCounter.
private void	increaseColumnCounter() this method increase the columnCounter.
protected java.lang.Boolean	isPackageDescriptionFileScanner()
private void	scan(java.io.InputStream input, java.lang.String dataPath) This method will be used to create a Symbolsequence.
private void	setCurrentExpression(java.lang.String currentExpression) set the currentExpression.
protected void	skip() This method skips the first character and increments the Column Counter.
protected PackageDescriptionFileScanner	toPackageDescriptionFileScanner()
protected static void	toSymbolSequence(java.io.InputStream input, java.lang.String dataPath, Scanner scanner) this methode will be used to call the Scanner.

Methods inherited from class java.lang.Object

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

Field Detail

buffer

private final Buffer<AbstractSymbol> buffer

This attribute represents a buffer of Symbols.

rowCounter

private java.lang.Integer rowCounter

This attribute represents the counter for the rows to show rownumbers.

columnCounter

private java.lang.Integer columnCounter

This attributer representes the counter for the columns to show columnnumbers.

currentExpression

private java.lang.String currentExpression

This attribute represents the currentExpression as String.

Constructor Detail

Scanner

public Scanner(Buffer<AbstractSymbol> buffer)

This is the constructoer to set the attributes.

Parameters:

buffer - is the symbolbuffer.

Method Detail

toSymbolSequence

protected static void toSymbolSequence(java.io.InputStream input,
                                       java.lang.String dataPath,
                                       Scanner scanner)
                                throws ScannerException,
                                       java.lang.InterruptedException,
                                       java.io.IOException

this methode will be used to call the Scanner.

Parameters:

input - is the input stream.

dataPath - is the path of the file, which will be scanned.

scanner - is the Scanner, which is used.

Throws:

ScannerException - is the Exception from all scanners.

java.lang.InterruptedException - if there is any problem with the buffer.

java.io.IOException - from the Stream.

scan

private void scan(java.io.InputStream input,
                  java.lang.String dataPath)
           throws ScannerException,
                  java.lang.InterruptedException,
                  java.io.IOException

This method will be used to create a Symbolsequence.

Parameters:

input - is the inputstream.

dataPath - is the dataPath to the file.

Throws:

ScannerException - is the Exception from all scanners.

java.lang.InterruptedException - for a Interruption in the method

java.io.IOException - is the Exception for the input or output

getColumnCounter

protected java.lang.Integer getColumnCounter()

Returns:

the CulumnCounter

getRowCounter

protected java.lang.Integer getRowCounter()

Returns:

the RowCounter

increaseColumnCounter

private void increaseColumnCounter()

this method increase the columnCounter.

handleRowEnd

protected void handleRowEnd()

this method increase the RowCounter.

getBuffer

private Buffer<AbstractSymbol> getBuffer()

Returns:

the Buffer

getCurrentExpression

private java.lang.String getCurrentExpression()

Returns:

the current Expression

setCurrentExpression

private void setCurrentExpression(java.lang.String currentExpression)

set the currentExpression.

Parameters:

currentExpression - is the currentExpression

skip

protected void skip()

This method skips the first character and increments the Column Counter.

getSelectionState

protected abstract AbstractState getSelectionState()

Returns:

the SelectionState of the special scanner.

getRestState

protected abstract AbstractState getRestState(java.lang.Integer beginningRow,
                                              java.lang.Integer beginningColumn)

Parameters:

beginningRow - is the beginning row of the symbol

beginningColumn - is the beginning column of the symbol

Returns:

AbstractState a reststate of the special scanner with the given beginning row and column.

toPackageDescriptionFileScanner

protected PackageDescriptionFileScanner toPackageDescriptionFileScanner()

Returns:

an error, if the symbol is not a descriptionfile scanner

isPackageDescriptionFileScanner

protected java.lang.Boolean isPackageDescriptionFileScanner()

Returns:

true if the Scanner is a PackageDescriptionFilescanner.