org.btrplace.btrpsl.includes

Class PathBasedIncludes

java.lang.Object

org.btrplace.btrpsl.includes.PathBasedIncludes

All Implemented Interfaces:

Includes

public class PathBasedIncludes
extends Object
implements Includes

An implementation that loop for the searched script among several folders. Similar to a shell path.

Author:

Fabien Hermenier

Constructor Summary

Constructors

Constructor and Description
PathBasedIncludes(ScriptBuilder vBuilder) Make a new instance that will browse a first folder.

Method Summary

Modifier and Type	Method and Description
boolean	addPath(File path) Add a new folder to browse.
List<File>	getPaths() Get all the given paths.
List<Script>	getScripts(String name) Get the script associated to a given identifier by browsing the given paths.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PathBasedIncludes

public PathBasedIncludes(ScriptBuilder vBuilder)

Make a new instance that will browse a first folder.

Parameters:

vBuilder - the builder to parse the scripts

Method Detail

getScripts

public List<Script> getScripts(String name)
                        throws ScriptBuilderException

Get the script associated to a given identifier by browsing the given paths. The first script having a matching identifier is selected, whatever the parsing process result will be

Specified by:

getScripts in interface Includes

Parameters:

name - the identifier of the script

Returns:

the script if found

Throws:

ScriptBuilderException - if the builder was not able to parse the looked script

addPath

public boolean addPath(File path)

Add a new folder to browse.

Parameters:

path - the path to the folder path must be an existing folder

Returns:

true if the path was added

getPaths

public List<File> getPaths()

Get all the given paths.

Returns:

a list of paths that may be empty

toString

public String toString()

Overrides:

toString in class Object