at.chrl.rebellion.scriptmanager

Class ScriptManager

java.lang.Object

at.chrl.rebellion.scriptmanager.ScriptManager

public class ScriptManager
extends Object

Class that represents managers of script contexts. It loads, reloads and unload script contexts. In the future it may be extended to support programatic manipulation of contexts, but for now it's not needed.
Example:

      ScriptManager sm = new ScriptManager();
      sm.load(new File("st/contexts.xml"));
      ...
      sm.shutdown();
 

Author:

SoulKeeper, Aquanox

Field Summary

Fields

Modifier and Type	Field and Description
static Class<? extends ScriptCompiler>	DEFAULT_COMPILER_CLASS

Constructor Summary

Constructors

Constructor and Description
ScriptManager()

Method Summary

Modifier and Type	Method and Description
protected ScriptContext	createContext(ScriptInfo si, ScriptContext parent) Creates new context and checks to not produce copies
Collection<ScriptContext>	getScriptContexts() Returns unmodifiable set with script contexts
void	load(File scriptDescriptor) Loads script contexes from descriptor
void	loadDirectory(File directory) Convenient method that is used to load all script files and libraries from specific directory.
void	loadDirectory(File directory, List<File> libraries, String compilerClassName) Load scripts directly from If you wish complex context hierarchy - you will have to use context descriptors
void	reload() Reloads all contexts
void	reloadContext(ScriptContext ctx) Reloads specified context.
void	setGlobalClassListener(ClassListener instance) Set Global class listener instance.
void	shutdown() Initializes shutdown on all contexts

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_COMPILER_CLASS

public static final Class<? extends ScriptCompiler> DEFAULT_COMPILER_CLASS

Constructor Detail

ScriptManager

public ScriptManager()

Method Detail

load

public void load(File scriptDescriptor)
          throws Exception

Loads script contexes from descriptor

Parameters:

scriptDescriptor - xml file that describes contexes

Throws:

Exception - if can't load file

loadDirectory

public void loadDirectory(File directory)
                   throws RuntimeException

Convenient method that is used to load all script files and libraries from specific directory.
Descriptor is not required.

If you wish complex context hierarchy - you will have to use context descriptors

.java files are treated as sources.
.jar files are treated as libraries.
Both .java and .jar files will be loaded recursively

Parameters:

directory - - directory with .java and .jar files

Throws:

RuntimeException - if failed to load script context

See Also:

DEFAULT_COMPILER_CLASS

loadDirectory

public void loadDirectory(File directory,
                          List<File> libraries,
                          String compilerClassName)
                   throws Exception

Load scripts directly from

If you wish complex context hierarchy - you will have to use context descriptors

Parameters:

directory - - directory with source files

libraries - - collection with libraries to load

compilerClassName - -

Throws:

Exception - if failed to load script context

createContext

protected ScriptContext createContext(ScriptInfo si,
                                      ScriptContext parent)
                               throws Exception

Creates new context and checks to not produce copies

Parameters:

si - script context descriptor

parent - parent script context

Returns:

created script context

Throws:

Exception - if can't create context

shutdown

public void shutdown()

Initializes shutdown on all contexts

reload

public void reload()

Reloads all contexts

reloadContext

public void reloadContext(ScriptContext ctx)

Reloads specified context.

Parameters:

ctx - Script context instance.

getScriptContexts

public Collection<ScriptContext> getScriptContexts()

Returns unmodifiable set with script contexts

Returns:

unmodifiable set of script contexts

setGlobalClassListener

public void setGlobalClassListener(ClassListener instance)

Set Global class listener instance.

Parameters:

instance - listener instance.