org.scripthelper.js

Class JSScriptWrapper<S>

java.lang.Object

org.scripthelper.model.AbstractScriptWrapper<S>

org.scripthelper.js.JSScriptWrapper<S>

Type Parameters:

S - the script interface

All Implemented Interfaces:

ScriptMethodInvoker, ScriptWrapper<S>

public class JSScriptWrapper<S>
extends AbstractScriptWrapper<S>

The Javascript Script wrapper.

Field Summary

Fields

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

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
JSScriptWrapper()

Method Summary

Modifier and Type	Method and Description
void	cacheInvocableMethods() Cache the invocable methods fore the current installed script.
boolean	compilerIsStrict() Return true if the compiler must be strict about interface methods implementations.
protected java.lang.Object	createScriptObject(java.lang.String scriptContent) Create the Javascript Object.
void	executeInGraphicThread(short executeInGraphicThread) Set the graphic framework in which the script must be executed.
protected ScriptException<S>	getCompileException(java.lang.Exception e) Return a proper exception from a Javascript 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() 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.
short	getGraphicThreadExecution() Return the graphic framework in which the script must be executed.
protected CachedMethodKey	getInvocableMethodKey(java.lang.String name, java.lang.Class<?>[] argTypes) Return the key for the invocable method with a specified name and arguments.
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 script MIME.
JSScriptable	getScriptable() Return the scriptable allowing to define built-in function properties that can be called in the Javascript script.
ScriptException<S>	getScriptException(java.lang.Throwable th) Create a Script exception from a Throwable.
java.lang.String	getScriptExtension() Return the script file extension.
protected short	getVariablesDeclarationsPosition() Return the position of the variables declaration.
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 JSScriptWrapper allows invocable methods are enabled for this wrapper.
static boolean	isJSException(java.lang.StackTraceElement st) Return true if the StackTraceElement corresponds to a Javascript exception.
boolean	isLibAvailable() Return true if the Rhino library is available.
boolean	isLibAvailable(java.lang.ClassLoader loader) Return true if the Rhino 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.
void	setCompilerIsStrict(boolean compilerIsStrict) Set if the compiler must be strict about interface methods implementations.
void	setScriptable(JSScriptable scriptable) Set a scriptable allowing to define built-in function properties that can be called in the Javascript script.

Methods inherited from class org.scripthelper.model.AbstractScriptWrapper

addAdditionalHelper, addExceptionListener, addImports, addImports, addImports, clearAdditionalHelpers, clearImports, convertPrimitiveArgument, countImportLines, createScriptContext, createScriptObject, err, getAdditionalHelpers, getClassLoader, getContextClassPath, getCustomImports, getExceptionListeners, getExecutionMode, getFilename, getHelperClassPath, getLineNumber, getLoggerClassPath, getOffset, getOptimizationLevel, getPreferredLogger, getRawScript, getScriptClassName, getScriptContent, getScriptContext, getScriptInterface, getScriptProxy, getSingletonMethod, getSource, hasAdditionalHelpers, hasScriptHelper, hasSingletonMethod, installScript, installScript, installScript, installScript, isLoggingExceptions, logExceptions, 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.ScriptWrapper

__step__, err, getLineNumber, getScript, getScriptProxy, getScriptProxyHandler, installScript, installScript, installScript, installScript, isDebugging, isDebugSupported, isInDebugSession, resetWrapperState

Methods inherited from interface org.scripthelper.model.ScriptMethodInvoker

hasInvocableMethod, invokeMethod, isInvocableByName

Field Detail

MIME

public static final java.lang.String MIME

The Javascript scripts MIME type.

See Also:

Constant Field Values

Constructor Detail

JSScriptWrapper

public JSScriptWrapper()

Method Detail

isLibAvailable

public boolean isLibAvailable()

Return true if the Rhino library is available.

Returns:

true if the Rhino library is available

executeInGraphicThread

public void executeInGraphicThread(short executeInGraphicThread)

Set the graphic framework in which the script must be executed. The possible values are:

• GraphicFramework.NONE: direct execution
• GraphicFramework.SWING: execution in the Swing event thread
• GraphicFramework.JAVAFX: execution in the JavaFX event thread

Parameters:

executeInGraphicThread - the graphic framework.

getGraphicThreadExecution

public short getGraphicThreadExecution()

Return the graphic framework in which the script must be executed.

Returns:

graphic framework in which the script must be executed

setCompilerIsStrict

public void setCompilerIsStrict(boolean compilerIsStrict)

Set if the compiler must be strict about interface methods implementations. If set to true, the compiler will throw a NotImplementedException is an interface method with no default implementation does not exist in the Javascript script.

Parameters:

compilerIsStrict - true if the compiler must be strict about interface methods implementations

compilerIsStrict

public boolean compilerIsStrict()

Return true if the compiler must be strict about interface methods implementations.

Returns:

true if the compiler must be strict about interface methods implementations

isLibAvailable

public boolean isLibAvailable(java.lang.ClassLoader loader)

Return true if the Rhino library is available.

Parameters:

loader - the Classloader

Returns:

true if the Rhino library is available

getMIME

public java.lang.String getMIME()

Return the script MIME.

Returns:

the script MIME

getScriptExtension

public java.lang.String getScriptExtension()

Return the script file extension.

Returns:

the script file extension

isMultiImplementSupported

public boolean isMultiImplementSupported()

Return true. The Javascript 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 JSScriptWrapper 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

getInvocableMethodKey

protected CachedMethodKey getInvocableMethodKey(java.lang.String name,
                                                java.lang.Class<?>[] argTypes)

Return the key for the invocable method with a specified name and arguments. Will return null if no method is found.

Overrides:

getInvocableMethodKey in class AbstractScriptWrapper<S>

Parameters:

name - the method name

argTypes - the method arguments

Returns:

the key for the invocable method

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

setScriptable

public void setScriptable(JSScriptable scriptable)

Set a scriptable allowing to define built-in function properties that can be called in the Javascript script. It also allows to use the same scope on several Javascript scripts. Using a JSScriptable s mandatory if you want to use:

• built-in properties (such as "document" for a script working on an HTML document), and methods on these properties
• built-in functions (such as "print" or "alert" for a script working on an HTML document)

Parameters:

scriptable - the scriptable

getScriptable

public JSScriptable getScriptable()

Return the scriptable allowing to define built-in function properties that can be called in the Javascript script. It also allows to use the same scope on several Javascript scripts. It can return null if there is no scriptable.

Returns:

the scriptable

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

getVariablesDeclarationsPosition

protected short getVariablesDeclarationsPosition()

Return the position of the variables declaration.

Overrides:

getVariablesDeclarationsPosition in class AbstractScriptWrapper<S>

Returns:

the position of the variables declaration

getDefaultDeclaration

protected java.lang.String getDefaultDeclaration()

Return the default declaration lines at the start of the script. This method allows to declare that the script is an instance of the Script interface.

Overrides:

getDefaultDeclaration in class AbstractScriptWrapper<S>

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.

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

createScriptObject

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

Create the Javascript Object.

Specified by:

createScriptObject in class AbstractScriptWrapper<S>

Parameters:

scriptContent - the script content

Returns:

the Ruby object as a generic class for the S type.

Throws:

java.lang.Exception - if the script instance coult not be created

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

isJSException

public static boolean isJSException(java.lang.StackTraceElement st)

Return true if the StackTraceElement corresponds to a Javascript exception.

Parameters:

st - the StackTraceElement

Returns:

true if the StackTraceElement corresponds to a Javascript exception

getCompileException

protected ScriptException<S> getCompileException(java.lang.Exception e)

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

Specified by:

getCompileException in class AbstractScriptWrapper<S>

Parameters:

e - the initial Exception

Returns:

the ScriptException