com.scriptbasic.readers

Class GenericHierarchicalReader

java.lang.Object

com.scriptbasic.readers.GenericHierarchicalReader

All Implemented Interfaces:

FactoryManaged, HierarchicalReader, Reader, SourceLocationBound

public class GenericHierarchicalReader
extends Object
implements HierarchicalReader

Constructor Summary

Constructors

Constructor and Description
GenericHierarchicalReader()

Method Summary

Methods

Modifier and Type	Method and Description
Integer	get() Get the next character from the input stream.
String	getFileName() Get the name of the file to which the object is bound to.
int	getLineNumber() Get the line number to which the object is bound to.
int	getPosition() Get the position on the line to which the object is bound to.
SourceProvider	getSourceProvider() Get the source provider that provided this reader.
void	include(Reader reader) Include a new reader into the chain and start to use that child reader so long as long exhausts.
void	pushBack(Integer ch) Readers should support lexical analyzers offering the possibility to push some characters back to the input stream, when a lexical analyzer can not decide its selection only consuming extra characters.
void	set(String sourceFileName)
void	setFactory(Factory factory) When a factory creates an instance of a class implementing this interface this method is called to register the factory that created the instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericHierarchicalReader

public GenericHierarchicalReader()

Method Detail

setFactory

public void setFactory(Factory factory)

Description copied from interface: FactoryManaged

When a factory creates an instance of a class implementing this interface this method is called to register the factory that created the instance.

Specified by:

setFactory in interface FactoryManaged

Parameters:

factory - the factory that manages the instance.

include

public void include(Reader reader)

Include a new reader into the chain and start to use that child reader so long as long exhausts.

Specified by:

include in interface HierarchicalReader

Parameters:

reader -

set

public void set(String sourceFileName)

Specified by:

set in interface Reader

getFileName

public String getFileName()

Description copied from interface: SourceLocationBound

Get the name of the file to which the object is bound to.

Specified by:

getFileName in interface SourceLocationBound

Returns:

the name of the file

getLineNumber

public int getLineNumber()

Description copied from interface: SourceLocationBound

Get the line number to which the object is bound to.

Specified by:

getLineNumber in interface SourceLocationBound

Returns:

the line number in the file

getPosition

public int getPosition()

Description copied from interface: SourceLocationBound

Get the position on the line to which the object is bound to.

Specified by:

getPosition in interface SourceLocationBound

Returns:

the position within the line

pushBack

public void pushBack(Integer ch)

Description copied from interface: Reader

Readers should support lexical analyzers offering the possibility to push some characters back to the input stream, when a lexical analyzer can not decide its selection only consuming extra characters.

Some of the readers may limit the operation of this push back functionality not supporting tracking line numbers, position and file name when this method is used.

Lexical analyzers should push back the characters that were read from the reader the backward order as they were read. (Read last pushed back first.)

Implementation should ignore null parameter.

Specified by:

pushBack in interface Reader

Parameters:

ch - the character to push back

get

public Integer get()

Get the next character from the input stream. This version implements hierarchical reading. When a source finishes, it returns to the parent reader and continues reading from there.

Specified by:

get in interface Reader

Returns:

getSourceProvider

public SourceProvider getSourceProvider()

Description copied from interface: Reader

Get the source provider that provided this reader.

Specified by:

getSourceProvider in interface Reader

Returns:

the source provider object.