com.scriptbasic.sourceproviders

Class AbstractSourceProvider

java.lang.Object

com.scriptbasic.sourceproviders.AbstractSourceProvider

All Implemented Interfaces:

SourceProvider

Direct Known Subclasses:

AbstractSingleIncludeSourceProvider, AbstractSourcePathSourceProvider

public abstract class AbstractSourceProvider
extends Object
implements SourceProvider

An abstract source provider to be extended by the source provider implementations.

Author:

Peter Verhas

Constructor Summary

Constructors

Constructor and Description
AbstractSourceProvider()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Reader	get(String sourceName) Get a reader to a source when there is no referencing source.
abstract Reader	get(String sourceName, String referencingSource) Get a reader to a source specifying the source that references this source.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSourceProvider

public AbstractSourceProvider()

Method Detail

get

public abstract 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

Parameters:

sourceName - the name of the source

Returns:

reader reading the source file.

Throws:

IOException

get

public abstract 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

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