org.scripthelper.ruby

Class RubyScriptWrapper<S>

java.lang.Object

org.scripthelper.model.AbstractScriptWrapper<S>

org.scripthelper.ruby.RubyScriptWrapper<S>

Type Parameters:

S - the script interface

All Implemented Interfaces:

ScriptMethodInvoker, ScriptWrapper<S>

public class RubyScriptWrapper<S>
extends AbstractScriptWrapper<S>

The Ruby Script wrapper.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEGIN
static java.lang.String	MIME The Ruby 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
RubyScriptWrapper()

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.
protected java.lang.Object	createScriptObject(java.lang.String scriptContent) Create the Ruby Object.
protected ScriptException<S>	getCompileException(java.lang.Exception e, java.io.File file, java.lang.Throwable caller) Return a proper exception from a Ruby 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 Ruby 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.
static java.io.File	getStdLibPath() Return the stdlib path.
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	isInvocableByName() Return true?
boolean	isInvocableMethodsEnabled() Return true because the RubyScriptWrapper allows invocable methods are enabled for this wrapper.
boolean	isLibAvailable() Return true if the JRuby library is available.
boolean	isLibAvailable(java.lang.ClassLoader loader) Return true if the JRuby library is available.
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.
static void	setStdLibPath(java.io.File stdlib) Set the stdlib path.

Methods inherited from class org.scripthelper.model.AbstractScriptWrapper

abort, addActiveScript, addAdditionalHelper, addExceptionListener, addImports, addImports, addImports, addUncompiledScript, clearActiveScriptFiles, clearAdditionalHelpers, clearImports, convertPrimitiveArgument, countImportLines, createScriptContext, createScriptObject, err, getActiveEncodedScriptFile, getActiveScriptFile, getActiveScripts, getActiveScriptSource, getAdditionalHelpers, getAdditionalScriptContent, getClassLoader, getCompileException, getContextClassPath, getCustomImports, getExceptionListeners, getExecutionMode, getFilename, getHelperClassPath, getInvocableMethodKey, getLineNumber, getLoggerClassPath, getOffset, getOptimizationLevel, getPreferredLogger, 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.ScriptWrapper

__step__, abort, createAdditionalScript, err, getLineNumber, getScript, getScriptProxy, getScriptProxyHandler, installScript, installScript, installScript, installScript, isDebugging, isDebugSupported, isInDebugSession, isMultiImplementSupported, isSingletonMethodEnabled, resetWrapperState

Methods inherited from interface org.scripthelper.model.ScriptMethodInvoker

hasInvocableMethod, invokeMethod

Field Detail

BEGIN

public static final java.lang.String BEGIN

See Also:

Constant Field Values

MIME

public static final java.lang.String MIME

The Ruby scripts MIME type.

See Also:

Constant Field Values

Constructor Detail

RubyScriptWrapper

public RubyScriptWrapper()

Method Detail

isLibAvailable

public boolean isLibAvailable()

Return true if the JRuby library is available.

Returns:

true if the JRuby library is available

isLibAvailable

public boolean isLibAvailable(java.lang.ClassLoader loader)

Return true if the JRuby library is available.

Parameters:

loader - the Classloader

Returns:

true if the JRuby library is available

getMIME

public java.lang.String getMIME()

Return the Ruby script MIME.

Returns:

the Ruby script MIME

setStdLibPath

public static void setStdLibPath(java.io.File stdlib)

Set the stdlib path.

Parameters:

stdlib - the stdlib path

getStdLibPath

public static java.io.File getStdLibPath()

Return the stdlib path.

Returns:

the stdlib path

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 "end".

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

isInvocableMethodsEnabled

public boolean isInvocableMethodsEnabled()

Return true because the RubyScriptWrapper 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

isInvocableByName

public boolean isInvocableByName()

Return true?

Returns:

true

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

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 Ruby 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 object could not be created. Usually it means that the script content is not a valid Ruby 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 Ruby 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