org.arl.fjage.shell

Class GroovyScriptEngine

java.lang.Object

org.arl.fjage.shell.GroovyScriptEngine

All Implemented Interfaces:

ScriptEngine

public class GroovyScriptEngine
extends java.lang.Object
implements ScriptEngine

Groovy scripting engine.

Constructor Summary

Constructors

Constructor and Description
GroovyScriptEngine()
GroovyScriptEngine(java.lang.ClassLoader cl)
GroovyScriptEngine(groovy.lang.GroovyClassLoader gcl)

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 cmd1) 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 ScriptEngine.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroovyScriptEngine

public GroovyScriptEngine()

GroovyScriptEngine

public GroovyScriptEngine(groovy.lang.GroovyClassLoader gcl)

GroovyScriptEngine

public GroovyScriptEngine(java.lang.ClassLoader cl)

Method Detail

bind

public void bind(Shell shell)

Description copied from interface: ScriptEngine

Bind input/output shell.

Specified by:

bind in interface ScriptEngine

Parameters:

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

getPrompt

public java.lang.String getPrompt(boolean cont)

Description copied from interface: ScriptEngine

Get the command prompt.

Specified by:

getPrompt in interface ScriptEngine

Parameters:

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

Returns:

prompt string or null to let shell choose prompt.

isComplete

public boolean isComplete(java.lang.String cmd)

Description copied from interface: ScriptEngine

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.

Specified by:

isComplete in interface ScriptEngine

Parameters:

cmd - command to check.

Returns:

true if complete, false if incomplete.

exec

public boolean exec(java.lang.String cmd1)

Description copied from interface: ScriptEngine

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

Specified by:

exec in interface ScriptEngine

Parameters:

cmd1 - command to execute.

Returns:

true if executed successfully, false if busy or error.

exec

public boolean exec(java.io.File script)

Description copied from interface: ScriptEngine

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

Specified by:

exec in interface ScriptEngine

Parameters:

script - script file to execute.

Returns:

true if executed successfully, false if busy or error.

exec

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

Description copied from interface: ScriptEngine

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

Specified by:

exec in interface ScriptEngine

Parameters:

script - script file to execute.

args - arguments to pass to script.

Returns:

true if executed successfully, false if busy or error.

exec

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

Description copied from interface: ScriptEngine

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

Specified by:

exec in interface ScriptEngine

Parameters:

script - script class to execute.

Returns:

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

exec

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

Description copied from interface: ScriptEngine

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

Specified by:

exec in interface ScriptEngine

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

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

Description copied from interface: ScriptEngine

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

Specified by:

exec in interface ScriptEngine

Parameters:

reader - reader to read script from.

name - reader name for logging.

Returns:

true if executed successfully, false if busy or error.

exec

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

Description copied from interface: ScriptEngine

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

Specified by:

exec in interface ScriptEngine

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.

isBusy

public boolean isBusy()

Description copied from interface: ScriptEngine

Check if script is currently being executed.

Specified by:

isBusy in interface ScriptEngine

abort

public void abort()

Description copied from interface: ScriptEngine

Abort currently running script.

Specified by:

abort in interface ScriptEngine

setVariable

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

Description copied from interface: ScriptEngine

Bind script variable.

Specified by:

setVariable in interface ScriptEngine

Parameters:

name - name of script variable.

value - of script variable.

getVariable

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

Description copied from interface: ScriptEngine

Get value of script variable.

Specified by:

getVariable in interface ScriptEngine

Parameters:

name - name of script variable.

Returns:

value of script variable.

importClasses

public void importClasses(java.lang.String clazz)

Description copied from interface: ScriptEngine

Make classes accessible from script without qualified names.

Specified by:

importClasses in interface ScriptEngine

Parameters:

clazz - qualified class name (with wildcards).

shutdown

public void shutdown()

Description copied from interface: ScriptEngine

Terminate the scripting engine.

Specified by:

shutdown in interface ScriptEngine

deliver

public void deliver(Message msg)

Description copied from interface: ScriptEngine

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

Specified by:

deliver in interface ScriptEngine

Parameters:

msg - message to deliver.

offer

public boolean offer(java.lang.String s)

Description copied from interface: ScriptEngine

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

Specified by:

offer in interface ScriptEngine

Parameters:

s - string input

Returns:

true if consumed, false otherwise

input

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

Description copied from interface: ScriptEngine

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

Specified by:

input in interface ScriptEngine

Returns:

input string, or null if input not supported

Throws:

java.lang.InterruptedException