com.scriptbasic.sourceproviders

Class AbstractSingleIncludeSourceProvider

java.lang.Object

com.scriptbasic.sourceproviders.AbstractSourceProvider

com.scriptbasic.sourceproviders.AbstractSingleIncludeSourceProvider

All Implemented Interfaces:

SourceProvider

Direct Known Subclasses:

SingleIncludeNonRelativeSourceProvider

public abstract class AbstractSingleIncludeSourceProvider
extends AbstractSourceProvider

An abstract class to be extended by the source provider implementations that do not want to include one source more than once.

The implementations should not override the methods get() but should implement the abstract methods getSource(). The method getSource() is invoked only when it is ensured that the source was not yet included.

Author:

Peter Verhas

Constructor Summary

Constructors

Constructor and Description
AbstractSingleIncludeSourceProvider()

Method Summary

Methods

Modifier and Type	Method and Description
Reader	get(String sourceName) Get a reader to a source when there is no referencing source.
Reader	get(String sourceName, String referencingSource) Get a reader to a source specifying the source that references this source.
protected abstract String	getKeyName(String sourceName)
protected abstract String	getKeyName(String sourceName, String referencingSource)
SingleIncludeChecker	getSingleInclude()
protected abstract Reader	getSource(String sourceName)
protected abstract Reader	getSource(String sourceName, String referencingSource)
void	setSingleInclude(SingleIncludeChecker singleInclude)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSingleIncludeSourceProvider

public AbstractSingleIncludeSourceProvider()

Method Detail

getSingleInclude

public SingleIncludeChecker getSingleInclude()

setSingleInclude

public void setSingleInclude(SingleIncludeChecker singleInclude)

get

public final Reader get(String sourceName)
                 throws IOException

Description copied from interface: SourceProvider

Get a reader to a source when there is no referencing source. This is the main source.

Specified by:

get in interface SourceProvider

Specified by:

get in class AbstractSourceProvider

Parameters:

sourceName - the name of the source

Returns:

reader reading the source file.

Throws:

IOException

get

public final Reader get(String sourceName,
         String referencingSource)
                 throws IOException

Description copied from interface: SourceProvider

Get a reader to a source specifying the source that references this source.

Specified by:

get in interface SourceProvider

Specified by:

get in class AbstractSourceProvider

Parameters:

sourceName - the name of the source to get the reader to.

referencingSource - the name of the source that is referencing the source to read.

Returns:

Throws:

IOException

getSource

protected abstract Reader getSource(String sourceName)
                             throws IOException

Throws:

IOException

getSource

protected abstract Reader getSource(String sourceName,
               String referencingSource)
                             throws IOException

Throws:

IOException

getKeyName

protected abstract String getKeyName(String sourceName)

getKeyName

protected abstract String getKeyName(String sourceName,
                String referencingSource)