votorola.g.script

Class JavaScriptIncluder

java.lang.Object

JavaScriptIncluder

@ThreadRestricted
public final class JavaScriptIncluder
extends Object

A facility for including JavaScript modules in a running script. Scripts executed in the engine are provided with a global instance of this includer (named vo), with which to load modules. For example:

vo.inc( 'ABS-OR-REL-PATH/module.jsm' );

Script files must be encoded in UTF-8, or equivalently ASCII.

Constructor Summary

Constructors

Constructor and Description
JavaScriptIncluder() Constructs a JavaScriptIncluder with a default engine, and no initial script.
JavaScriptIncluder(File scriptFile) Constructs a JavaScriptIncluder with a default engine.
JavaScriptIncluder(File scriptFile, ScriptEngine _engine) Constructs a JavaScriptIncluder with the specified engine.

Method Summary

Methods

Modifier and Type	Method and Description
ScriptEngine	engine() Returns the engine in which included modules are executed.
void	inc(File file) Includes a JavaScript file by executing it in the engine.
void	inc(String path) Includes a JavaScript file by executing it in the engine.
Object	invokeKnownFunction(String name, Object... args) The same as (Invocable)engine().
File	scriptFile() The path to the first file that was executed by inclusion.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaScriptIncluder

public JavaScriptIncluder()
                   throws ScriptException

Constructs a JavaScriptIncluder with a default engine, and no initial script.

Throws:

ScriptException

JavaScriptIncluder

public JavaScriptIncluder(File scriptFile)
                   throws IOException,
                          ScriptException

Constructs a JavaScriptIncluder with a default engine.

Parameters:

scriptFile - to execute initially, per scriptFile(); or null to execute none

Throws:

IOException

ScriptException

JavaScriptIncluder

public JavaScriptIncluder(File scriptFile,
                  ScriptEngine _engine)
                   throws IOException,
                          ScriptException

Constructs a JavaScriptIncluder with the specified engine.

Parameters:

scriptFile - to execute initially, per scriptFile(); or null to execute none

Throws:

IOException

ScriptException

Method Detail

engine

public ScriptEngine engine()

Returns the engine in which included modules are executed.

inc

public void inc(File file)
         throws IOException,
                ScriptException

Includes a JavaScript file by executing it in the engine.

Parameters:

file - the absolute path to the file

Throws:

IOException

ScriptException

inc

public void inc(String path)
         throws IOException,
                ScriptException

Includes a JavaScript file by executing it in the engine.

Parameters:

path - the file's absolute or relative path, per resolveFile(path)

Throws:

IOException

ScriptException

invokeKnownFunction

public Object invokeKnownFunction(String name,
                         Object... args)
                           throws ScriptException

The same as (Invocable)engine().invokeFunction(name,args), but throws MisconfigurationException instead of NoSuchMethodException.

Throws:

ScriptException

scriptFile

public File scriptFile()

The path to the first file that was executed by inclusion. It is guaranteed to be in canonical form.

Returns:

path to first file that was executed, or null if none was executed

See Also:

inc(String), inc(File)