JTR 5.0 API Documentation

jtr.script.impl
Class GroovyScriptEngine

java.lang.Object
  extended by jtr.script.impl.AbstractScriptEngine
      extended by jtr.script.impl.GroovyScriptEngine
All Implemented Interfaces:
IFactory, IScriptEngine

public class GroovyScriptEngine
extends AbstractScriptEngine

Groovy-based script-engine for the JTR runtime.

Since:
5.0
Version:
5.0
Author:
frusso

Nested Class Summary
 
Nested classes/interfaces inherited from class jtr.script.impl.AbstractScriptEngine
AbstractScriptEngine.StructuredScript
 
Field Summary
 
Fields inherited from class jtr.script.impl.AbstractScriptEngine
GLOBAL_JTR_CTX_IDENTIFIER, logger
 
Constructor Summary
  GroovyScriptEngine()
           
protected GroovyScriptEngine(groovy.lang.Binding b)
           
 
Method Summary
 java.lang.Object execute(java.lang.String scriptUID, ScriptParams actualParams, IScriptContext ctx)
          Executes the given script.
 IScriptEngine newInstance()
           
protected  void setBooleanActualParameter(java.lang.String fpName, java.lang.Boolean apValue)
          Method that engine-specific subclasses must implement for setting actual parameters before execution.
protected  void setDoubleActualParameter(java.lang.String fpName, java.lang.Double apValue)
          Method that engine-specific subclasses must implement for setting actual parameters before execution.
protected  void setFloatActualParameter(java.lang.String fpName, java.lang.Float apValue)
          Method that engine-specific subclasses must implement for setting actual parameters before execution.
protected  void setIntegerActualParameter(java.lang.String fpName, java.lang.Integer apValue)
          Method that engine-specific subclasses must implement for setting actual parameters before execution.
protected  void setLongActualParameter(java.lang.String fpName, java.lang.Long apValue)
          Method that engine-specific subclasses must implement for setting actual parameters before execution.
protected  void setObjectActualParameter(java.lang.String fpName, java.lang.Object apValue)
          Method that engine-specific subclasses must implement for setting actual parameters before execution.
 
Methods inherited from class jtr.script.impl.AbstractScriptEngine
consolidateLibrary, defineScript, findScript, getEndStatementPattern, getImportPattern, getScripts, restructureScript, setActualParameters, setScripts
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroovyScriptEngine

public GroovyScriptEngine()

GroovyScriptEngine

protected GroovyScriptEngine(groovy.lang.Binding b)
Method Detail

newInstance

public IScriptEngine newInstance()

execute

public java.lang.Object execute(java.lang.String scriptUID,
                                ScriptParams actualParams,
                                IScriptContext ctx)
                         throws ScriptException
Executes the given script.

Parameters:
scriptUID -
actualParams -
ctx -
Returns:
Throws:
ScriptException

setBooleanActualParameter

protected void setBooleanActualParameter(java.lang.String fpName,
                                         java.lang.Boolean apValue)
Description copied from class: AbstractScriptEngine
Method that engine-specific subclasses must implement for setting actual parameters before execution.

Specified by:
setBooleanActualParameter in class AbstractScriptEngine

setDoubleActualParameter

protected void setDoubleActualParameter(java.lang.String fpName,
                                        java.lang.Double apValue)
Description copied from class: AbstractScriptEngine
Method that engine-specific subclasses must implement for setting actual parameters before execution.

Specified by:
setDoubleActualParameter in class AbstractScriptEngine

setFloatActualParameter

protected void setFloatActualParameter(java.lang.String fpName,
                                       java.lang.Float apValue)
Description copied from class: AbstractScriptEngine
Method that engine-specific subclasses must implement for setting actual parameters before execution.

Specified by:
setFloatActualParameter in class AbstractScriptEngine

setIntegerActualParameter

protected void setIntegerActualParameter(java.lang.String fpName,
                                         java.lang.Integer apValue)
Description copied from class: AbstractScriptEngine
Method that engine-specific subclasses must implement for setting actual parameters before execution.

Specified by:
setIntegerActualParameter in class AbstractScriptEngine

setLongActualParameter

protected void setLongActualParameter(java.lang.String fpName,
                                      java.lang.Long apValue)
Description copied from class: AbstractScriptEngine
Method that engine-specific subclasses must implement for setting actual parameters before execution.

Specified by:
setLongActualParameter in class AbstractScriptEngine

setObjectActualParameter

protected void setObjectActualParameter(java.lang.String fpName,
                                        java.lang.Object apValue)
Description copied from class: AbstractScriptEngine
Method that engine-specific subclasses must implement for setting actual parameters before execution.

Specified by:
setObjectActualParameter in class AbstractScriptEngine

The JTR Project is licensed under GPL version 2