org.scripthelper.groovy

Class GroovyScriptWrapper<S>

java.lang.Object

org.scripthelper.model.AbstractScriptWrapper<S>

org.scripthelper.model.AbstractDebuggingScriptWrapper<S>

org.scripthelper.groovy.GroovyScriptWrapper<S>

Type Parameters:

S - the script interface

All Implemented Interfaces:

DebuggingWrapper<S>, ScriptMethodInvoker, ScriptWrapper<S>

public class GroovyScriptWrapper<S>
extends AbstractDebuggingScriptWrapper<S>

The Groovy Script wrapper.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MIME The groovy scripts MIME type.

Fields inherited from class org.scripthelper.model.AbstractDebuggingScriptWrapper

debugListener, parentWrapper, session

Fields inherited from class org.scripthelper.model.AbstractScriptWrapper

additionalHelpers, context, exListeners, firstException, hasCustomHelper, helper, importLines, logger, offset, optimLevel, scriptContent, source, VARIABLES_DECL_AFTER_CLASS_DECL, VARIABLES_DECL_BEFORE_CLASS_DECL

Fields inherited from interface org.scripthelper.model.ScriptWrapper

MODE_BLOCKING, MODE_NON_BLOCKING, OPTIM_LEVEL_DEFAULT, OPTIM_LEVEL_MAX, OPTIM_LEVEL_MIN

Constructor Summary

Constructors

Constructor and Description
GroovyScriptWrapper()
GroovyScriptWrapper(DebuggingWrapper<?> parentWrapper)

Method Summary

Modifier and Type	Method and Description
void	cacheInvocableMethods() Cache the invocable methods fore the current installed script.
java.lang.Object	createAdditionalScript(java.io.File file, boolean useContext) Create another script that can be used in the current script.
DebugSession<S>	createDebugSession() Create a debug session.
protected java.lang.Object	createScriptObject(java.lang.String scriptContent) Create the Groovy Object.
protected ScriptException<S>	getCompileException(java.lang.Exception e, java.io.File file, java.lang.Throwable caller) Return a proper exception from a Groovy compile-time exception, with the correct file and line number.
protected java.lang.String	getDefaultContent() Return the default content lines at the start of the script.
protected java.lang.String	getDefaultDeclaration(ScriptSource source, boolean isCallingScript) Return the default declaration lines at the start of the script.
protected java.lang.String	getDefaultImports() Return the default import lines at the start of the script.
protected java.lang.String	getEnd() Return the lines at the end of the script.
java.util.Set<CachedMethodKey>	getInvocableMethods() Return the invocable methods for the current installed script.
java.util.Map<java.lang.String,java.util.Set<CachedMethodKey>>	getInvocableMethodsByNames() Return the invocable methods sorted by their names for the current installed script.
java.lang.String	getMIME() Return the groovy script MIME.
ScriptException<S>	getScriptException(java.lang.Throwable th) Create a Script exception from a Throwable.
java.lang.String	getScriptExtension() Return the script file extension.
java.lang.Object	invokeMethod(java.lang.String name, java.lang.Object... args) Invoke directly a method by reflection for the current installed script.
boolean	isAutoCachingInvocableMethods() Return true if a cache of invocable methods will be created each time the wrapper installs a new script.
boolean	isInvocableMethodsEnabled() Return true because the GroovyScriptWrapper allows invocable methods are enabled for this wrapper.
boolean	isLibAvailable() Return true if the Groovy library is available.
boolean	isLibAvailable(java.lang.ClassLoader loader) Return true if the Groovy library is available.
boolean	isMultiImplementSupported() Return true.
boolean	isSingletonMethodEnabled() Return true.
protected boolean	parseScript(ScriptSource source, ScriptContent content) Parse the script content.
void	setAutoCacheInvocableMethods(boolean autoCache) Set if a cache of invocable methods will be created each time the wrapper installs a new script.

Methods inherited from class org.scripthelper.model.AbstractDebuggingScriptWrapper

__step__, endDebugSession, err, getDebugListener, getDebugSession, getLineNumber, getLineNumber, getParentWrapper, getPreferredLogger, initializeDebugSession, isDebugging, isInDebugSession, setDebugListener

Methods inherited from class org.scripthelper.model.AbstractScriptWrapper

abort, addActiveScript, addAdditionalHelper, addExceptionListener, addImports, addImports, addImports, addUncompiledScript, clearActiveScriptFiles, clearAdditionalHelpers, clearImports, convertPrimitiveArgument, countImportLines, createScriptContext, createScriptObject, getActiveEncodedScriptFile, getActiveScriptFile, getActiveScripts, getActiveScriptSource, getAdditionalHelpers, getAdditionalScriptContent, getClassLoader, getCompileException, getContextClassPath, getCustomImports, getExceptionListeners, getExecutionMode, getFilename, getHelperClassPath, getInvocableMethodKey, getLoggerClassPath, getOffset, getOptimizationLevel, getRawScript, getRuntimeException, getRuntimeException, getScriptClassName, getScriptContent, getScriptContext, getScriptFile, getScriptInterface, getScriptProxy, getSingletonMethod, getSource, getVariablesDeclarationsPosition, hasActiveScriptFile, hasAdditionalHelpers, hasScriptHelper, hasSingletonMethod, installScript, installScript, installScript, installScript, isLoggingExceptions, logExceptions, notifyExceptionToListeners, reInstallScript, reInstallScript, reInstallScript, removeExceptionListener, removeTabulations, setClassLoader, setExecutionMode, setOptimizationLevel, setScriptContext, setScriptLogger, startMethod

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.scripthelper.model.DebuggingWrapper

isDebugSupported

Methods inherited from interface org.scripthelper.model.ScriptWrapper

abort, abort, addAdditionalHelper, addExceptionListener, addImports, addImports, addImports, clearAdditionalHelpers, clearImports, countImportLines, createAdditionalScript, err, getActiveEncodedScriptFile, getActiveScriptFile, getActiveScripts, getActiveScriptSource, getAdditionalHelpers, getClassLoader, getExceptionListeners, getExecutionMode, getFilename, getOffset, getOptimizationLevel, getRawScript, getScript, getScriptClassName, getScriptContent, getScriptContext, getScriptFile, getScriptInterface, getScriptProxy, getScriptProxy, getScriptProxyHandler, getSource, hasActiveScriptFile, hasAdditionalHelpers, hasScriptHelper, hasSingletonMethod, installScript, installScript, installScript, installScript, installScript, installScript, installScript, installScript, isLoggingExceptions, logExceptions, reInstallScript, removeExceptionListener, resetWrapperState, setClassLoader, setExecutionMode, setOptimizationLevel, setScriptContext, setScriptLogger, startMethod

Methods inherited from interface org.scripthelper.model.ScriptMethodInvoker

hasInvocableMethod, invokeMethod, isInvocableByName

Field Detail

MIME

public static final java.lang.String MIME

The groovy scripts MIME type.

See Also:

Constant Field Values

Constructor Detail

GroovyScriptWrapper

public GroovyScriptWrapper(DebuggingWrapper<?> parentWrapper)

GroovyScriptWrapper

public GroovyScriptWrapper()

Method Detail

isLibAvailable

public boolean isLibAvailable()

Return true if the Groovy library is available.

Returns:

true if the Groovy library is available

isLibAvailable

public boolean isLibAvailable(java.lang.ClassLoader loader)

Return true if the Groovy library is available.

Parameters:

loader - the Classloader

Returns:

true if the Groovy library is available

getMIME

public java.lang.String getMIME()

Return the groovy script MIME.

Returns:

the groovy script MIME

getScriptExtension

public java.lang.String getScriptExtension()

Return the script file extension.

Returns:

the script file extension

getDefaultImports

protected java.lang.String getDefaultImports()

Return the default import lines at the start of the script.

Overrides:

getDefaultImports in class AbstractScriptWrapper<S>

Returns:

the default import lines at the start of the script

getDefaultDeclaration

protected java.lang.String getDefaultDeclaration(ScriptSource source,
                                                 boolean isCallingScript)

Return the default declaration lines at the start of the script.

Overrides:

getDefaultDeclaration in class AbstractScriptWrapper<S>

Parameters:

isCallingScript - true for the calling script

source - the script source

Returns:

the default declaration lines at the start of the script

getEnd

protected java.lang.String getEnd()

Return the lines at the end of the script. Return null by default.

Overrides:

getEnd in class AbstractScriptWrapper<S>

Returns:

the lines at the end of the script

getDefaultContent

protected java.lang.String getDefaultContent()

Return the default content lines at the start of the script.

Overrides:

getDefaultContent in class AbstractScriptWrapper<S>

Returns:

the default content lines at the start of the script

isMultiImplementSupported

public boolean isMultiImplementSupported()

Return true. The Groovy Scripting language implementation support the implementation of multiple interfaces.

Returns:

true

isSingletonMethodEnabled

public boolean isSingletonMethodEnabled()

Return true. The Groovy Scripting language implementation support defining a script without any method.

Returns:

true

isInvocableMethodsEnabled

public boolean isInvocableMethodsEnabled()

Return true because the GroovyScriptWrapper allows invocable methods are enabled for this wrapper.

Returns:

true

isAutoCachingInvocableMethods

public boolean isAutoCachingInvocableMethods()

Return true if a cache of invocable methods will be created each time the wrapper installs a new script.

Returns:

true if a cache of invocable methods will be created each time the wrapper installs a new script

setAutoCacheInvocableMethods

public void setAutoCacheInvocableMethods(boolean autoCache)

Set if a cache of invocable methods will be created each time the wrapper installs a new script.

Parameters:

autoCache - true if a cache of invocable methods will be created each time the wrapper installs a new script

cacheInvocableMethods

public void cacheInvocableMethods()

Cache the invocable methods fore the current installed script.

getInvocableMethods

public java.util.Set<CachedMethodKey> getInvocableMethods()

Return the invocable methods for the current installed script.

Returns:

the invocable methods

getInvocableMethodsByNames

public java.util.Map<java.lang.String,java.util.Set<CachedMethodKey>> getInvocableMethodsByNames()

Return the invocable methods sorted by their names for the current installed script.

Returns:

the invocable methods sorted by their names

invokeMethod

public java.lang.Object invokeMethod(java.lang.String name,
                                     java.lang.Object... args)

Invoke directly a method by reflection for the current installed script.

Parameters:

name - the method name

args - the method arguments

Returns:

the returned value

createDebugSession

public DebugSession<S> createDebugSession()
                                   throws java.lang.Exception

Create a debug session.

Specified by:

createDebugSession in interface DebuggingWrapper<S>

Overrides:

createDebugSession in class AbstractDebuggingScriptWrapper<S>

Returns:

the DebugSession

Throws:

java.lang.Exception

createAdditionalScript

public java.lang.Object createAdditionalScript(java.io.File file,
                                               boolean useContext)
                                        throws ScriptRuntimeException

Description copied from interface: ScriptWrapper

Create another script that can be used in the current script.

Parameters:

file - the script file

useContext - true if the additional script must use the context

Returns:

the script object

Throws:

ScriptRuntimeException - if the script could not be created (the file may not exist, or the syntax is invalid)

createScriptObject

protected java.lang.Object createScriptObject(java.lang.String scriptContent)
                                       throws java.lang.Exception

Create the Groovy Object.

Specified by:

createScriptObject in class AbstractScriptWrapper<S>

Parameters:

scriptContent - the content to use for the script creation

Returns:

the GroovyObject

Throws:

java.lang.Exception - if the object could not be created. Usually it means that the script content is not a valid Groovy script

parseScript

protected boolean parseScript(ScriptSource source,
                              ScriptContent content)

Description copied from class: AbstractScriptWrapper

Parse the script content. You usually should separate the import declarations from the rest of the script.

Specified by:

parseScript in class AbstractScriptWrapper<S>

Parameters:

source - the script source

content - the content object

Returns:

true if the parsing succeeded

getScriptException

public ScriptException<S> getScriptException(java.lang.Throwable th)

Description copied from interface: ScriptWrapper

Create a Script exception from a Throwable.

Parameters:

th - the Throwable

Returns:

the ScriptException

getCompileException

protected ScriptException<S> getCompileException(java.lang.Exception e,
                                                 java.io.File file,
                                                 java.lang.Throwable caller)

Return a proper exception from a Groovy compile-time exception, with the correct file and line number.

Specified by:

getCompileException in class AbstractScriptWrapper<S>

Parameters:

e - the initial Exception

file - the file from which the exception originates

caller - the caller

Returns:

the ScriptException