org.scripthelper.model

Class ScriptWrapperCombiner

java.lang.Object

org.scripthelper.model.ScriptWrapperCombiner

All Implemented Interfaces:

DebuggingWrapper<java.lang.Object>, ScriptMethodInvoker, ScriptWrapper<java.lang.Object>

public class ScriptWrapperCombiner
extends java.lang.Object
implements ScriptWrapper<java.lang.Object>, DebuggingWrapper<java.lang.Object>

A Script wrapper which can represent several script wrappers depending on the script file.

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	__step__(java.lang.Object... args) Fired when entering a step.
void	abort(java.lang.String message) Abort the script execution.
void	addExceptionListener(ScriptExceptionListener listener) Add a listener which will be fired for script exceptions.
void	addImports(java.lang.Class<?>... imports) Do nothing.
void	addImports(java.util.Set<java.lang.String> imports) Do nothing.
void	addImports(java.lang.String... imports) Do nothing.
boolean	addScriptWrapper(ScriptWrapper<?> wrapper) Add a script wrapper to the list of scripts to use.
void	clearImports() Do nothing.
int	countImportLines() Return the number of import lines.
java.lang.Object	createAdditionalScript(java.io.File file, boolean useContext) Create another script that can be used in the current script.
void	err(java.lang.String message, char errorType, java.lang.Throwable e) Log an error.
ScriptWrapper<?>	findAndInstallScript(java.io.File file) Create the script, using the current context ClassLoader.
ScriptWrapper<?>	findAndInstallScript(java.io.File file, java.lang.ClassLoader loader) Create the script.
ScriptWrapper<?>	findAndInstallScript(ScriptSource source, java.lang.ClassLoader loader) Create the script.
ScriptWrapper<?>	findAndInstallScript(java.lang.String content, java.lang.ClassLoader loader) Create the script.
ScriptWrapper<?>	findAndInstallScript(java.net.URL url) Create the script, using the current context ClassLoader.
java.io.File	getActiveEncodedScriptFile(java.lang.Object key) Return the active script file for an encoded script key.
java.io.File	getActiveScriptFile(java.lang.String name) Return the active script file for an effective script name.
ActiveScripts	getActiveScripts() Return the active scripts of the currently used script wrapper.
ScriptSource	getActiveScriptSource(java.lang.String name) Return the active script source for a script name.
java.lang.ClassLoader	getClassLoader() Return the ClassLoader.
java.util.List<ScriptExceptionListener>	getExceptionListeners() Return the listeners which will be fired for script exceptions.
short	getExecutionMode() Return the execution mode.
java.lang.String	getFilename() Return the script filename.
java.lang.String	getMIME() Return the script MIME.
int	getOffset() Return the script offset after the import lines.
java.lang.Object	getRawScript() Return the script.
java.lang.String	getScriptClassName() Return the class name of the script.
java.lang.String	getScriptContent() Return the script text content.
ScriptContext	getScriptContext() Return the script context.
ScriptException	getScriptException(java.lang.Throwable th) Create a Script exception from a Throwable.
java.lang.String	getScriptExtension() Return the script file extension.
java.io.File	getScriptFile(java.lang.String name) Return the script file for an effective script name.
java.lang.Class	getScriptInterface() Return the class of the script interface.
ScriptProxy	getScriptProxy(java.lang.Object script) Return the script proxy.
ScriptWrapper<?>	getScriptWrapper() Return the currently used script wrapper.
java.util.List<AbstractScriptWrapper<?>>	getScriptWrappers() Return the list of script wrappers to use.
ScriptSource	getSource() Return the script source.
boolean	hasActiveScriptFile(java.lang.String name) Return true if there is an active script file for an effective script name.
boolean	hasScriptHelper() Return true if there is a script helper.
java.lang.Object	installScript(java.io.File file) Create the script, using the current context ClassLoader.
java.lang.Object	installScript(java.io.File file, java.lang.ClassLoader loader) Create the script.
java.lang.Object	installScript(ScriptSource source, java.lang.ClassLoader loader) Create the script.
java.lang.Object	installScript(java.net.URL url) Create the script, using the current context ClassLoader.
java.lang.Object	installScript(java.net.URL url, java.lang.ClassLoader loader) Create the script.
boolean	isDebugging() Return true if the wrapper is in a debug session and debugging.
boolean	isInDebugSession() Return true if the wrapper is in a debug session.
java.lang.Object	reInstallScript() Reinstall an already installed script.
boolean	removeExceptionListener(ScriptExceptionListener listener) Remove a previously added exception listener.
void	setClassLoader(java.lang.ClassLoader loader) Set the ClassLoader.
void	setExecutionMode(short mode) Set the execution mode.
void	setScriptContext(ScriptContext context) Set the script context.
void	setScriptLogger(ScriptLogger logger) Set the script logger.
void	startMethod() Start a script method.

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

createDebugSession, endDebugSession, getDebugListener, getDebugSession, getParentWrapper, initializeDebugSession, isDebugSupported, setDebugListener

Methods inherited from interface org.scripthelper.model.ScriptWrapper

abort, addAdditionalHelper, clearAdditionalHelpers, createAdditionalScript, err, getAdditionalHelpers, getLineNumber, getLineNumber, getOptimizationLevel, getScript, getScriptProxy, getScriptProxyHandler, hasAdditionalHelpers, hasSingletonMethod, installScript, installScript, installScript, isLibAvailable, isLibAvailable, isLoggingExceptions, isMultiImplementSupported, isSingletonMethodEnabled, logExceptions, resetWrapperState, setOptimizationLevel

Methods inherited from interface org.scripthelper.model.ScriptMethodInvoker

cacheInvocableMethods, getInvocableMethods, getInvocableMethodsByNames, hasInvocableMethod, invokeMethod, invokeMethod, isAutoCachingInvocableMethods, isInvocableByName, isInvocableMethodsEnabled, setAutoCacheInvocableMethods

Constructor Detail

ScriptWrapperCombiner

public ScriptWrapperCombiner()

Method Detail

getMIME

public java.lang.String getMIME()

Return the script MIME. Note that it will not be nulln only when the associated script has been found.

Specified by:

getMIME in interface ScriptWrapper<java.lang.Object>

Returns:

the script MIME

addScriptWrapper

public boolean addScriptWrapper(ScriptWrapper<?> wrapper)

Add a script wrapper to the list of scripts to use. Note that the wrapper must be an AbstractScriptWrapper.

Parameters:

wrapper - the script wrapper

Returns:

true if the wrapper could be added

getScriptWrappers

public java.util.List<AbstractScriptWrapper<?>> getScriptWrappers()

Return the list of script wrappers to use.

Returns:

the list of script wrappers

getScriptWrapper

public ScriptWrapper<?> getScriptWrapper()

Return the currently used script wrapper. It is not null only after the script file has been installed* and a suitable wrapper has been found.

Returns:

the currently used script wrapper

getActiveScripts

public ActiveScripts getActiveScripts()

Return the active scripts of the currently used script wrapper.

Specified by:

getActiveScripts in interface ScriptWrapper<java.lang.Object>

Returns:

the active scripts

getActiveEncodedScriptFile

public java.io.File getActiveEncodedScriptFile(java.lang.Object key)

Return the active script file for an encoded script key.

Specified by:

getActiveEncodedScriptFile in interface ScriptWrapper<java.lang.Object>

Parameters:

key - the encoded script key

Returns:

the active script file for the encoded script key.

getActiveScriptFile

public java.io.File getActiveScriptFile(java.lang.String name)

Return the active script file for an effective script name.

Specified by:

getActiveScriptFile in interface ScriptWrapper<java.lang.Object>

Parameters:

name - the script name

Returns:

the active script file for the script name.

getScriptFile

public java.io.File getScriptFile(java.lang.String name)

Return the script file for an effective script name.

Specified by:

getScriptFile in interface ScriptWrapper<java.lang.Object>

Parameters:

name - the script name

Returns:

the script file for the script name

hasActiveScriptFile

public boolean hasActiveScriptFile(java.lang.String name)

Return true if there is an active script file for an effective script name.

Specified by:

hasActiveScriptFile in interface ScriptWrapper<java.lang.Object>

Parameters:

name - the script name

Returns:

true if there is an active script file for the script name

getActiveScriptSource

public ScriptSource getActiveScriptSource(java.lang.String name)

Return the active script source for a script name.

Specified by:

getActiveScriptSource in interface ScriptWrapper<java.lang.Object>

Parameters:

name - the script name

Returns:

the active script source for the script name.

setExecutionMode

public void setExecutionMode(short mode)

Set the execution mode.

Specified by:

setExecutionMode in interface ScriptWrapper<java.lang.Object>

Parameters:

mode - the execution mode

getExecutionMode

public short getExecutionMode()

Return the execution mode.

Specified by:

getExecutionMode in interface ScriptWrapper<java.lang.Object>

Returns:

the execution mode

createAdditionalScript

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

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

Specified by:

createAdditionalScript in interface ScriptWrapper<java.lang.Object>

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)

findAndInstallScript

public ScriptWrapper<?> findAndInstallScript(java.net.URL url)

Create the script, using the current context ClassLoader.

Parameters:

url - the script URL

Returns:

the ScriptWrapper

findAndInstallScript

public ScriptWrapper<?> findAndInstallScript(java.io.File file)

Create the script, using the current context ClassLoader.

Parameters:

file - the script file

Returns:

the ScriptWrapper

findAndInstallScript

public ScriptWrapper<?> findAndInstallScript(java.io.File file,
                                             java.lang.ClassLoader loader)

Create the script.

Parameters:

file - the script file

loader - the ClassLoader

Returns:

the ScriptWrapper

findAndInstallScript

public ScriptWrapper<?> findAndInstallScript(java.lang.String content,
                                             java.lang.ClassLoader loader)

Create the script.

Parameters:

content - the script content

loader - the ClassLoader

Returns:

the ScriptWrapper

findAndInstallScript

public ScriptWrapper<?> findAndInstallScript(ScriptSource source,
                                             java.lang.ClassLoader loader)

Create the script.

Parameters:

source - the script source

loader - the ClassLoader

Returns:

the ScriptWrapper

installScript

public java.lang.Object installScript(java.net.URL url)

Create the script, using the current context ClassLoader.

Specified by:

installScript in interface ScriptWrapper<java.lang.Object>

Parameters:

url - the script URL

Returns:

the ScriptWrapper

installScript

public java.lang.Object installScript(java.io.File file)

Create the script, using the current context ClassLoader.

Specified by:

installScript in interface ScriptWrapper<java.lang.Object>

Parameters:

file - the script file

Returns:

the ScriptWrapper

installScript

public java.lang.Object installScript(java.net.URL url,
                                      java.lang.ClassLoader loader)

Create the script.

Specified by:

installScript in interface ScriptWrapper<java.lang.Object>

Parameters:

url - the script URL

loader - the ClassLoader

Returns:

the ScriptWrapper

installScript

public java.lang.Object installScript(java.io.File file,
                                      java.lang.ClassLoader loader)

Create the script.

Specified by:

installScript in interface ScriptWrapper<java.lang.Object>

Parameters:

file - the script file

loader - the ClassLoader

Returns:

the ScriptWrapper

installScript

public java.lang.Object installScript(ScriptSource source,
                                      java.lang.ClassLoader loader)

Create the script.

Specified by:

installScript in interface ScriptWrapper<java.lang.Object>

Parameters:

source - the script source

loader - the ClassLoader

Returns:

the ScriptWrapper

setClassLoader

public void setClassLoader(java.lang.ClassLoader loader)

Set the ClassLoader.

Specified by:

setClassLoader in interface ScriptWrapper<java.lang.Object>

Parameters:

loader - the ClassLoader

getClassLoader

public java.lang.ClassLoader getClassLoader()

Return the ClassLoader.

Specified by:

getClassLoader in interface ScriptWrapper<java.lang.Object>

Returns:

the ClassLoader

addExceptionListener

public void addExceptionListener(ScriptExceptionListener listener)

Add a listener which will be fired for script exceptions.

Specified by:

addExceptionListener in interface ScriptWrapper<java.lang.Object>

Parameters:

listener - the listener

getExceptionListeners

public java.util.List<ScriptExceptionListener> getExceptionListeners()

Return the listeners which will be fired for script exceptions.

Specified by:

getExceptionListeners in interface ScriptWrapper<java.lang.Object>

Returns:

the listeners

removeExceptionListener

public boolean removeExceptionListener(ScriptExceptionListener listener)

Remove a previously added exception listener.

Specified by:

removeExceptionListener in interface ScriptWrapper<java.lang.Object>

Parameters:

listener - the listener

Returns:

true if the listeners was previously existing

setScriptContext

public void setScriptContext(ScriptContext context)

Set the script context.

Specified by:

setScriptContext in interface ScriptWrapper<java.lang.Object>

Parameters:

context - the script context

getScriptContent

public java.lang.String getScriptContent()

Return the script text content. This will be the content used to create the script class.

Specified by:

getScriptContent in interface ScriptWrapper<java.lang.Object>

Returns:

the script text content

getScriptContext

public ScriptContext getScriptContext()

Return the script context.

Specified by:

getScriptContext in interface ScriptWrapper<java.lang.Object>

Returns:

the script context

hasScriptHelper

public boolean hasScriptHelper()

Return true if there is a script helper.

Specified by:

hasScriptHelper in interface ScriptWrapper<java.lang.Object>

Returns:

true if there is a script helper

getRawScript

public java.lang.Object getRawScript()

Return the script.

Specified by:

getRawScript in interface ScriptWrapper<java.lang.Object>

Returns:

the script

getScriptProxy

public ScriptProxy getScriptProxy(java.lang.Object script)

Return the script proxy.

Specified by:

getScriptProxy in interface ScriptWrapper<java.lang.Object>

Parameters:

script - the script

Returns:

the script proxy

getScriptInterface

public java.lang.Class getScriptInterface()

Return the class of the script interface.

Specified by:

getScriptInterface in interface ScriptWrapper<java.lang.Object>

Returns:

the class of the script interface

getScriptClassName

public java.lang.String getScriptClassName()

Return the class name of the script.

Specified by:

getScriptClassName in interface ScriptWrapper<java.lang.Object>

Returns:

the class name of the script

getSource

public ScriptSource getSource()

Return the script source.

Specified by:

getSource in interface ScriptWrapper<java.lang.Object>

Returns:

the script source

getFilename

public java.lang.String getFilename()

Return the script filename.

Specified by:

getFilename in interface ScriptWrapper<java.lang.Object>

Returns:

the script filename

addImports

public void addImports(java.util.Set<java.lang.String> imports)

Do nothing.

Specified by:

addImports in interface ScriptWrapper<java.lang.Object>

Parameters:

imports - the additional custom import declarations

addImports

public void addImports(java.lang.String... imports)

Do nothing.

Specified by:

addImports in interface ScriptWrapper<java.lang.Object>

Parameters:

imports - the additional custom import declarations

addImports

public void addImports(java.lang.Class<?>... imports)

Do nothing.

Specified by:

addImports in interface ScriptWrapper<java.lang.Object>

Parameters:

imports - the additional custom import declarations

clearImports

public void clearImports()

Do nothing.

Specified by:

clearImports in interface ScriptWrapper<java.lang.Object>

getOffset

public int getOffset()

Return the script offset after the import lines.

Specified by:

getOffset in interface ScriptWrapper<java.lang.Object>

Returns:

the script offset

countImportLines

public int countImportLines()

Return the number of import lines. This only concern the import lines in the initial script.

Specified by:

countImportLines in interface ScriptWrapper<java.lang.Object>

Returns:

the number of import lines

getScriptExtension

public java.lang.String getScriptExtension()

Return the script file extension.

Specified by:

getScriptExtension in interface ScriptWrapper<java.lang.Object>

Returns:

the script file extension

getScriptException

public ScriptException getScriptException(java.lang.Throwable th)

Create a Script exception from a Throwable.

Specified by:

getScriptException in interface ScriptWrapper<java.lang.Object>

Parameters:

th - the Throwable

Returns:

the ScriptException

setScriptLogger

public void setScriptLogger(ScriptLogger logger)

Set the script logger.

Specified by:

setScriptLogger in interface ScriptWrapper<java.lang.Object>

Parameters:

logger - the script logger

reInstallScript

public java.lang.Object reInstallScript()

Reinstall an already installed script.

Specified by:

reInstallScript in interface ScriptWrapper<java.lang.Object>

Returns:

the Script

abort

public void abort(java.lang.String message)

Abort the script execution.

Specified by:

abort in interface ScriptWrapper<java.lang.Object>

Parameters:

message - the abort message (can be null)

startMethod

public void startMethod()

Start a script method.

Specified by:

startMethod in interface ScriptWrapper<java.lang.Object>

err

public void err(java.lang.String message,
                char errorType,
                java.lang.Throwable e)

Log an error.

Specified by:

err in interface ScriptWrapper<java.lang.Object>

Parameters:

message - the error message

errorType - the error type

e - the Throwable

See Also:

ErrorType

isDebugging

public boolean isDebugging()

Return true if the wrapper is in a debug session and debugging.

Specified by:

isDebugging in interface ScriptWrapper<java.lang.Object>

Returns:

false by default

isInDebugSession

public boolean isInDebugSession()

Return true if the wrapper is in a debug session.

Specified by:

isInDebugSession in interface ScriptWrapper<java.lang.Object>

Returns:

true if the wrapper is in a debug session

__step__

public void __step__(java.lang.Object... args)

Fired when entering a step.

Specified by:

__step__ in interface ScriptWrapper<java.lang.Object>

Parameters:

args - the arguments