org.arl.fjage.shell

Interface ScriptEngine

All Known Implementing Classes:

EchoScriptEngine, GroovyScriptEngine

public interface ScriptEngine

An interface representing a scripting engine.

Method Summary

Modifier and Type	Method and Description
void	abort() Abort currently running script.
void	bind(Shell shell) Bind input/output shell.
void	deliver(Message msg) Deliver message to user, typically by displaying it on the shell in an appropriate format.
boolean	exec(java.lang.Class<?> script) Execute a precompiled script.
boolean	exec(java.lang.Class<?> script, java.util.List<java.lang.String> args) Execute a precomplied script.
boolean	exec(java.io.File script) Execute a script file.
boolean	exec(java.io.File script, java.util.List<java.lang.String> args) Execute a script file.
boolean	exec(java.io.Reader reader, java.lang.String name) Execute a script from a reader.
boolean	exec(java.io.Reader reader, java.lang.String name, java.util.List<java.lang.String> args) Execute a script from a reader.
boolean	exec(java.lang.String cmd) Execute a command.
java.lang.String	getPrompt(boolean cont) Get the command prompt.
java.lang.Object	getVariable(java.lang.String name) Get value of script variable.
void	importClasses(java.lang.String clazz) Make classes accessible from script without qualified names.
java.lang.String	input() Gets an input offered by offer(String).
boolean	isBusy() Check if script is currently being executed.
boolean	isComplete(java.lang.String cmd) Checks if a string is a complete command.
boolean	offer(java.lang.String s) Offers a string input to a running script.
void	setVariable(java.lang.String name, java.lang.Object value) Bind script variable.
void	shutdown() Terminate the scripting engine.

Method Detail

bind

void bind(Shell shell)

Bind input/output shell.

Parameters:

shell - shell for input/output (null to supress).

getPrompt

java.lang.String getPrompt(boolean cont)

Get the command prompt.

Parameters:

cont - true if continuation line, false if first line.

Returns:

prompt string or null to let shell choose prompt.

isComplete

boolean isComplete(java.lang.String cmd)

Checks if a string is a complete command. This can be used by a shell to determine if a multiline command is being composed by the user.

Parameters:

cmd - command to check.

Returns:

true if complete, false if incomplete.

exec

boolean exec(java.lang.String cmd)

Execute a command. The method waits for execution to be completed.

Parameters:

cmd - command to execute.

Returns:

true if executed successfully, false if busy or error.

exec

boolean exec(java.io.File script)

Execute a script file. The method waits for execution to be completed.

Parameters:

script - script file to execute.

Returns:

true if executed successfully, false if busy or error.

exec

boolean exec(java.io.File script,
             java.util.List<java.lang.String> args)

Execute a script file. The method waits for execution to be completed.

Parameters:

script - script file to execute.

args - arguments to pass to script.

Returns:

true if executed successfully, false if busy or error.

exec

boolean exec(java.lang.Class<?> script)

Execute a precompiled script. The method waits for execution to be completed.

Parameters:

script - script class to execute.

Returns:

true if executed successfully, false if busy or error or unable to instantiate class.

exec

boolean exec(java.lang.Class<?> script,
             java.util.List<java.lang.String> args)

Execute a precomplied script. The method waits for execution to be completed.

Parameters:

script - script class to execute.

args - arguments to pass to script.

Returns:

true if executed successfully, false if busy or error or unable to instantiate class.

exec

boolean exec(java.io.Reader reader,
             java.lang.String name)

Execute a script from a reader. The method waits for execution to be completed.

Parameters:

reader - reader to read script from.

name - reader name for logging.

Returns:

true if executed successfully, false if busy or error.

exec

boolean exec(java.io.Reader reader,
             java.lang.String name,
             java.util.List<java.lang.String> args)

Execute a script from a reader. The method waits for execution to be completed.

Parameters:

reader - reader to read script from.

name - reader name for logging.

args - arguments to pass to script.

Returns:

true if executed successfully, false if busy or error.

deliver

void deliver(Message msg)

Deliver message to user, typically by displaying it on the shell in an appropriate format.

Parameters:

msg - message to deliver.

offer

boolean offer(java.lang.String s)

Offers a string input to a running script. This is used to allow interactive scripts.

Parameters:

s - string input

Returns:

true if consumed, false otherwise

input

java.lang.String input()
                throws java.lang.InterruptedException

Gets an input offered by offer(String). Blocks until an input is available or an interrupt. This is used to allow interactive scripts.

Returns:

input string, or null if input not supported

Throws:

java.lang.InterruptedException

isBusy

boolean isBusy()

Check if script is currently being executed.

abort

void abort()

Abort currently running script.

setVariable

void setVariable(java.lang.String name,
                 java.lang.Object value)

Bind script variable.

Parameters:

name - name of script variable.

value - of script variable.

getVariable

java.lang.Object getVariable(java.lang.String name)

Get value of script variable.

Parameters:

name - name of script variable.

Returns:

value of script variable.

importClasses

void importClasses(java.lang.String clazz)

Make classes accessible from script without qualified names.

Parameters:

clazz - qualified class name (with wildcards).

shutdown

void shutdown()

Terminate the scripting engine.