scanner

Class PackageDescriptionFileScanner

java.lang.Object

scanner.Scanner

scanner.PackageDescriptionFileScanner

public final class PackageDescriptionFileScanner
extends Scanner

scanner for package description files.

Author:

Lisa Leitloff

Field Summary

Fields

Modifier and Type	Field and Description
private DescriptionBlock	descriptionBlock represents the Blocks in the Descriptionfile.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PackageDescriptionFileScanner(Buffer<AbstractSymbol> buffer) create a PackageDescriptionFileScanner and sets the PackageDescriptionSelectionState as initial state.

Method Summary

Modifier and Type	Method and Description
protected DescriptionBlock	getDescriptionBlock()
protected AbstractState	getRestState(java.lang.Integer beginningRow, java.lang.Integer beginningColumn)
protected AbstractState	getSelectionState()
protected void	handleRowEnd() this method increase the RowCounter.
protected java.lang.Boolean	isPackageDescriptionFileScanner()
protected void	setDescriptionBlock(DescriptionBlock descriptionBlock)
protected PackageDescriptionFileScanner	toPackageDescriptionFileScanner()
static void	toSymbolSequence(java.io.InputStream input, java.lang.String dataPath, Buffer<AbstractSymbol> buffer) creates a scanner and starts him.

Methods inherited from class scanner.Scanner

getColumnCounter, getRowCounter, skip, toSymbolSequence

Methods inherited from class java.lang.Object

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

Field Detail

descriptionBlock

private DescriptionBlock descriptionBlock

represents the Blocks in the Descriptionfile.

Constructor Detail

PackageDescriptionFileScanner

private PackageDescriptionFileScanner(Buffer<AbstractSymbol> buffer)

create a PackageDescriptionFileScanner and sets the PackageDescriptionSelectionState as initial state.

Parameters:

buffer - a buffer for the created Symbols

Method Detail

toSymbolSequence

public static void toSymbolSequence(java.io.InputStream input,
                                    java.lang.String dataPath,
                                    Buffer<AbstractSymbol> buffer)
                             throws ScannerException,
                                    java.lang.InterruptedException,
                                    java.io.IOException

creates a scanner and starts him.

Parameters:

input - is the input stream.

dataPath - is the path of the file.

buffer - if the buffer for the symbols.

Throws:

java.io.IOException - from the Input Stream.

java.lang.InterruptedException - from the buffer.

ScannerException - if there is any problem during the scan.

getSelectionState

protected AbstractState getSelectionState()

Specified by:

getSelectionState in class Scanner

Returns:

the SelectionState of the special scanner.

getRestState

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

Specified by:

getRestState in class Scanner

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.

getDescriptionBlock

protected DescriptionBlock getDescriptionBlock()

Returns:

the descriptionBlock

setDescriptionBlock

protected void setDescriptionBlock(DescriptionBlock descriptionBlock)

Parameters:

descriptionBlock - the descriptionBlock to set

toPackageDescriptionFileScanner

protected PackageDescriptionFileScanner toPackageDescriptionFileScanner()

Overrides:

toPackageDescriptionFileScanner in class Scanner

Returns:

the PackageDescriptionFileScanner.

handleRowEnd

protected void handleRowEnd()

Description copied from class: Scanner

this method increase the RowCounter.

Overrides:

handleRowEnd in class Scanner

isPackageDescriptionFileScanner

protected java.lang.Boolean isPackageDescriptionFileScanner()

Overrides:

isPackageDescriptionFileScanner in class Scanner

Returns:

true if the Scanner is a PackageDescriptionFilescanner.