com.scriptbasic.interfaces

Interface SourceProvider

All Known Implementing Classes:

AbstractSingleIncludeSourcePathSourceProvider, AbstractSingleIncludeSourceProvider, AbstractSourcePathSourceProvider, AbstractSourceProvider, FileSourceProvider, SingleIncludeNonRelativeSourceProvider, SingleIncludeSourcePathNonRelativeSourceProvider, StringSourceProvider

public interface SourceProvider

A source provider gives a reader for a source based upon the name of the source.

When source files reference each other the source provider may alter its behavior finding the source based on which source is referencing the other source.

For example you want to get a reader to the source named myProg.sb This program may include using the include statement inc/incProg.sb. The second file is in the directory inc. If that file includes myProg.sb then source provider may provide a reader to the file inc/myProg.sb.

Source providers may provide readers reading the source from files, database, svn and other locations.

Author:

Peter Verhas

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.

Method Detail

get

Reader get(String sourceName)
           throws IOException

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

Parameters:

sourceName - the name of the source

Returns:

reader reading the source file.

Throws:

IOException

get

Reader get(String sourceName,
         String referencingSource)
           throws IOException

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

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