ScriptWrapper

Type Parameters:

S - the script interface

All Superinterfaces:

ScriptMethodInvoker

All Known Subinterfaces:

DebuggingWrapper<S>

All Known Implementing Classes:

AbstractDebuggingScriptWrapper, AbstractScriptWrapper, GroovyScriptWrapper, JSScriptWrapper, PythonScriptWrapper, RubyScriptWrapper, ScriptWrapperCombiner
```
public interface ScriptWrapper<S>
extends ScriptMethodInvoker
```
The ScriptWrapper class.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`MODE_BLOCKING` The default mode, for blocking Wrappers.
`static short`	`MODE_NON_BLOCKING` The mode for non blocking Wrappers.
`static java.lang.String`	`OPTIM_LEVEL_DEFAULT` "default": The default optimization level.
`static java.lang.String`	`OPTIM_LEVEL_MAX` "maximum": The maximum optimization level.
`static java.lang.String`	`OPTIM_LEVEL_MIN` "minimum": The minimum optimization level.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`__step__(java.lang.Object... args)` Fired when entering a step in debug.
`default void`	`addAdditionalHelper(java.lang.String name, java.lang.Object helper)` Add an additional helper instance which will be usable in the script.
`void`	`addExceptionListener(ScriptExceptionListener listener)` Add a listener which will be fired for script exceptions.
`void`	`addImports(java.lang.Class<?>... imports)` Set additional custom import declarations for the scripts.
`void`	`addImports(java.util.Set<java.lang.String> imports)` Add additional custom import declarations for the scripts.
`void`	`addImports(java.lang.String... imports)` Add additional custom import declarations for the scripts.
`default void`	`clearAdditionalHelpers()` Clear the additional helper instances.
`void`	`clearImports()` Clear the import declarations.
`int`	`countImportLines()` Return the number of import lines.
`void`	`err(java.lang.String message, char errorType, java.lang.Throwable e)` Log an error.
`default void`	`err(java.lang.String message, java.lang.Throwable e)` Log an error, with a `ErrorType.RUNTIME` error type.
`default java.util.Map<java.lang.String,java.lang.Object>`	`getAdditionalHelpers()` Return the additional helper instances.
`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.
`default int`	`getLineNumber(int lineNumber)` Return the effective line number of a line detected in the script runtime.
`default int`	`getLineNumber(int lineNumber, boolean isException)` Return the effective line number of a line detected in the script runtime.
`java.lang.String`	`getMIME()` Return the script MIME.
`int`	`getOffset()` Return the script offset after the import lines.
`default java.lang.String`	`getOptimizationLevel()` Return the default optimization level.
`S`	`getRawScript()` Return the raw script.
`default S`	`getScript()` Return the script proxy.
`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<S>`	`getScriptException(java.lang.Throwable th)` Create a Script exception from a Throwable.
`java.lang.String`	`getScriptExtension()` Return the script file extension.
`java.lang.Class<S>`	`getScriptInterface()` Return the class of the script interface.
`default ScriptProxy<S>`	`getScriptProxy()` Return the script proxy.
`ScriptProxy<S>`	`getScriptProxy(S script)` Return the script proxy, for a specified script.
`default ScriptProxy<S>`	`getScriptProxyHandler()` Return the script proxy.
`ScriptSource`	`getSource()` Return the script source.
`default boolean`	`hasAdditionalHelpers()` Return true the there are additional helper instances.
`boolean`	`hasScriptHelper()` Return true if there is a script helper.
`default boolean`	`hasSingletonMethod()` Return true if there is a singleton method.
`default S`	`installScript(java.io.File file)` Install the script, using the current context ClassLoader.
`S`	`installScript(java.io.File file, java.lang.ClassLoader loader)` Install the script.
`default S`	`installScript(ScriptSource source)` Install the script, using the current context ClassLoader.
`S`	`installScript(ScriptSource source, java.lang.ClassLoader loader)` Install the script.
`default S`	`installScript(java.lang.String content)` Install the script, using the current context ClassLoader.
`default S`	`installScript(java.lang.String content, java.lang.ClassLoader loader)` Install the script.
`default S`	`installScript(java.net.URL url)` Install the script, using the current context ClassLoader.
`default S`	`installScript(java.net.URL url, java.lang.ClassLoader loader)` Install the script.
`default boolean`	`isDebugging()` Return true if the wrapper is in a debug session and debugging.
`default boolean`	`isDebugSupported()` Return true is debugging is supported.
`default boolean`	`isInDebugSession()` Return true if the wrapper is in a debug session.
`default boolean`	`isLibAvailable()` Return true if the script library is available.
`default boolean`	`isLibAvailable(java.lang.ClassLoader loader)` Return true if the script library is available.
`default boolean`	`isLoggingExceptions()` Return true if the wrapper must log exceptions (default is false).
`default boolean`	`isMultiImplementSupported()` Return true if the Scripting language implementation support the implementation of multiple interfaces.
`default boolean`	`isSingletonMethodEnabled()` Return true if the Scripting language implementation support defining a script without any method.
`default void`	`logExceptions(boolean isLoggingExceptions)` Set if the wrapper must log exceptions.
`S`	`reInstallScript()` Reinstall an already installed script.
`boolean`	`removeExceptionListener(ScriptExceptionListener listener)` Remove a previously added exception listener.
`default void`	`resetWrapperState()` Reset the wrapper state.
`void`	`setClassLoader(java.lang.ClassLoader loader)` Set the ClassLoader.
`void`	`setExecutionMode(short mode)` Set the execution mode.
`default void`	`setOptimizationLevel(java.lang.String optimLevel)` Set the optimization level.
`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 interface org.scripthelper.model.ScriptMethodInvoker
cacheInvocableMethods, getInvocableMethods, getInvocableMethodsByNames, hasInvocableMethod, invokeMethod, invokeMethod, isAutoCachingInvocableMethods, isInvocableByName, isInvocableMethodsEnabled, setAutoCacheInvocableMethods

- Field Detail
  - MODE_BLOCKING
```
static final short MODE_BLOCKING
```
    The default mode, for blocking Wrappers.
    
    See Also:
    
    Constant Field Values
  - MODE_NON_BLOCKING
```
static final short MODE_NON_BLOCKING
```
    The mode for non blocking Wrappers.
    
    See Also:
    
    Constant Field Values
  - OPTIM_LEVEL_DEFAULT
```
static final java.lang.String OPTIM_LEVEL_DEFAULT
```
    "default": The default optimization level.
    
    See Also:
    
    Constant Field Values
  - OPTIM_LEVEL_MIN
```
static final java.lang.String OPTIM_LEVEL_MIN
```
    "minimum": The minimum optimization level.
    
    See Also:
    
    Constant Field Values
  - OPTIM_LEVEL_MAX
```
static final java.lang.String OPTIM_LEVEL_MAX
```
    "maximum": The maximum optimization level.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - isLibAvailable
```
default boolean isLibAvailable()
```
    Return true if the script library is available. Return true by default.
    
    Returns:
    
    true if the script library is available
  - isLibAvailable
```
default boolean isLibAvailable(java.lang.ClassLoader loader)
```
    Return true if the script library is available. Return true by default.
    
    Parameters:
    
    loader - the Classloader
    
    Returns:
    
    true if the script library is available
  - getMIME
```
java.lang.String getMIME()
```
    Return the script MIME.
    
    Returns:
    
    the script MIME
  - setExecutionMode
```
void setExecutionMode(short mode)
```
    Set the execution mode.
    
    Parameters:
    
    mode - the execution mode
  - getExecutionMode
```
short getExecutionMode()
```
    Return the execution mode.
    
    Returns:
    
    the execution mode
  - getOptimizationLevel
```
default java.lang.String getOptimizationLevel()
```
    Return the default optimization level.
    
    Returns:
    
    the default optimization level
  - setOptimizationLevel
```
default void setOptimizationLevel(java.lang.String optimLevel)
```
    Set the optimization level. Do nothing by default. Can be one of the following values:
    - "default": the default optimization level
    - "minimum": the minimum optimization level
    - "maximum": the maximum optimization level
    - any int value: a specified optimization level (depend if the scripting library allow them)
    - other value: do nothing
    Parameters:
    
    optimLevel - the optimization level
  - setClassLoader
```
void setClassLoader(java.lang.ClassLoader loader)
```
    Set the ClassLoader.
    
    Parameters:
    
    loader - the ClassLoader
  - getClassLoader
```
java.lang.ClassLoader getClassLoader()
```
    Return the ClassLoader.
    
    Returns:
    
    the ClassLoader
  - isMultiImplementSupported
```
default boolean isMultiImplementSupported()
```
    Return true if the Scripting language implementation support the implementation of multiple interfaces. Return false by default.
    
    Returns:
    
    true if the Scripting language implementation support the implementation of multiple interfaces
  - isSingletonMethodEnabled
```
default boolean isSingletonMethodEnabled()
```
    Return true if the Scripting language implementation support defining a script without any method. Return false by default.
    
    Returns:
    
    true if the Scripting language implementation support defining a script without any method
  - hasSingletonMethod
```
default boolean hasSingletonMethod()
```
    Return true if there is a singleton method. Return false by default.
    
    Returns:
    
    true if there is a singleton method
  - addExceptionListener
```
void addExceptionListener(ScriptExceptionListener listener)
```
    Add a listener which will be fired for script exceptions.
    
    Parameters:
    
    listener - the listener
  - getExceptionListeners
```
java.util.List<ScriptExceptionListener> getExceptionListeners()
```
    Return the listeners which will be fired for script exceptions.
    
    Returns:
    
    the listeners
  - removeExceptionListener
```
boolean removeExceptionListener(ScriptExceptionListener listener)
```
    Remove a previously added exception listener.
    
    Parameters:
    
    listener - the listener
    
    Returns:
    
    true if the listeners was previously existing
  - setScriptContext
```
void setScriptContext(ScriptContext context)
```
    Set the script context.
    
    Parameters:
    
    context - the script context
  - getScriptContext
```
ScriptContext getScriptContext()
```
    Return the script context.
    
    Returns:
    
    the script context
  - hasScriptHelper
```
boolean hasScriptHelper()
```
    Return true if there is a script helper.
    
    Returns:
    
    true if there is a script helper
  - getScriptContent
```
java.lang.String getScriptContent()
```
    Return the script text content. This will be the content used to create the script class.
    
    Returns:
    
    the script text content
  - getRawScript
```
S getRawScript()
```
    Return the raw script. Note that the raw script exceptions are not catched if you use this script directly. Use getScript() instead if you want to be able to catch exceptions.
    
    Returns:
    
    the raw script
  - getScript
```
default S getScript()
```
    Return the script proxy. This returns the same result as getScriptProxy(). Exceptions will be catched by the ScriptExceptionListeners if isLoggingExceptions() returns true.
    
    Returns:
    
    the script proxy
  - getScriptProxyHandler
```
default ScriptProxy<S> getScriptProxyHandler()
```
    Return the script proxy. This returns the same result as getScriptProxy(). Exceptions will be catched by the ScriptExceptionListeners if isLoggingExceptions() returns true.
    
    Returns:
    
    the script proxy
  - getScriptProxy
```
default ScriptProxy<S> getScriptProxy()
```
    Return the script proxy. Exceptions will be catched by the ScriptExceptionListeners if isLoggingExceptions() returns true.
    
    Returns:
    
    the script proxy
  - getScriptProxy
```
ScriptProxy<S> getScriptProxy(S script)
```
    Return the script proxy, for a specified script.
    
    Parameters:
    
    script - the script
    
    Returns:
    
    the script proxy
  - getScriptInterface
```
java.lang.Class<S> getScriptInterface()
```
    Return the class of the script interface.
    
    Returns:
    
    the class of the script interface
  - getScriptClassName
```
java.lang.String getScriptClassName()
```
    Return the class name of the script.
    
    Returns:
    
    the class name of the script
  - getSource
```
ScriptSource getSource()
```
    Return the script source.
    
    Returns:
    
    the script source
  - getFilename
```
java.lang.String getFilename()
```
    Return the script filename.
    
    Returns:
    
    the script filename
  - addImports
```
void addImports(java.lang.Class<?>... imports)
```
    Set additional custom import declarations for the scripts.
    
    Parameters:
    
    imports - the additional custom import declarations
  - addImports
```
void addImports(java.util.Set<java.lang.String> imports)
```
    Add additional custom import declarations for the scripts.
    
    Parameters:
    
    imports - the additional custom import declarations
  - addImports
```
void addImports(java.lang.String... imports)
```
    Add additional custom import declarations for the scripts.
    
    Parameters:
    
    imports - the additional custom import declarations
  - clearImports
```
void clearImports()
```
    Clear the import declarations.
  - addAdditionalHelper
```
default void addAdditionalHelper(java.lang.String name,
                                 java.lang.Object helper)
```
    Add an additional helper instance which will be usable in the script.
    
    Parameters:
    
    name - the helper instance name
    
    helper - the helper instance
  - getAdditionalHelpers
```
default java.util.Map<java.lang.String,java.lang.Object> getAdditionalHelpers()
```
    Return the additional helper instances.
    
    Returns:
    
    the additional helper instances.
  - hasAdditionalHelpers
```
default boolean hasAdditionalHelpers()
```
    Return true the there are additional helper instances.
    
    Returns:
    
    true the there are additional helper instances
  - clearAdditionalHelpers
```
default void clearAdditionalHelpers()
```
    Clear the additional helper instances.
  - getOffset
```
int getOffset()
```
    Return the script offset after the import lines.
    
    Returns:
    
    the script offset
  - countImportLines
```
int countImportLines()
```
    Return the number of import lines. This only concern the import lines in the initial script.
    
    Returns:
    
    the number of import lines
  - getLineNumber
```
default int getLineNumber(int lineNumber)
```
    Return the effective line number of a line detected in the script runtime.
    
    Parameters:
    
    lineNumber - the line number
    
    Returns:
    
    the effective line number
  - getLineNumber
```
default int getLineNumber(int lineNumber,
                          boolean isException)
```
    Return the effective line number of a line detected in the script runtime.
    
    Parameters:
    
    lineNumber - the line number
    
    isException - true for getting the line number for an exception
    
    Returns:
    
    the effective line number
  - getScriptExtension
```
java.lang.String getScriptExtension()
```
    Return the script file extension.
    
    Returns:
    
    the script file extension
  - getScriptException
```
ScriptException<S> getScriptException(java.lang.Throwable th)
```
    Create a Script exception from a Throwable.
    
    Parameters:
    
    th - the Throwable
    
    Returns:
    
    the ScriptException
  - setScriptLogger
```
void setScriptLogger(ScriptLogger logger)
```
    Set the script logger.
    
    Parameters:
    
    logger - the script logger
  - installScript
```
default S installScript(java.net.URL url)
```
    Install the script, using the current context ClassLoader.
    
    Parameters:
    
    url - the script url
    
    Returns:
    
    the script
  - installScript
```
default S installScript(java.io.File file)
```
    Install the script, using the current context ClassLoader.
    
    Parameters:
    
    file - the script file
    
    Returns:
    
    the script
  - installScript
```
default S installScript(java.lang.String content)
```
    Install the script, using the current context ClassLoader.
    
    Parameters:
    
    content - the script content
    
    Returns:
    
    the script
  - installScript
```
default S installScript(ScriptSource source)
```
    Install the script, using the current context ClassLoader.
    
    Parameters:
    
    source - the script source
    
    Returns:
    
    the script
  - reInstallScript
```
S reInstallScript()
```
    Reinstall an already installed script.
    
    Returns:
    
    the Script
  - isDebugging
```
default boolean isDebugging()
```
    Return true if the wrapper is in a debug session and debugging.
    
    Returns:
    
    false by default
  - isInDebugSession
```
default boolean isInDebugSession()
```
    Return true if the wrapper is in a debug session.
    
    Returns:
    
    false by default
  - isDebugSupported
```
default boolean isDebugSupported()
```
    Return true is debugging is supported.
    
    Returns:
    
    false by default
  - __step__
```
default void __step__(java.lang.Object... args)
```
    Fired when entering a step in debug. Do nothing by default
    
    Parameters:
    
    args - the arguments
  - installScript
```
default S installScript(java.net.URL url,
                        java.lang.ClassLoader loader)
```
    Install the script.
    
    Parameters:
    
    url - the script URL
    
    loader - the ClassLoader
    
    Returns:
    
    the script
  - installScript
```
S installScript(java.io.File file,
                java.lang.ClassLoader loader)
```
    Install the script.
    
    Parameters:
    
    file - the script file
    
    loader - the ClassLoader
    
    Returns:
    
    the script
  - installScript
```
default S installScript(java.lang.String content,
                        java.lang.ClassLoader loader)
```
    Install the script.
    
    Parameters:
    
    content - the script content
    
    loader - the ClassLoader
    
    Returns:
    
    the script
  - installScript
```
S installScript(ScriptSource source,
                java.lang.ClassLoader loader)
```
    Install the script.
    
    Parameters:
    
    source - the script source
    
    loader - the ClassLoader
    
    Returns:
    
    the script
  - startMethod
```
void startMethod()
```
    Start a script method.
  - resetWrapperState
```
default void resetWrapperState()
```
    Reset the wrapper state. Defer to startMethod() by default.
  - logExceptions
```
default void logExceptions(boolean isLoggingExceptions)
```
    Set if the wrapper must log exceptions.
    
    Parameters:
    
    isLoggingExceptions - true if the wrapper must log exceptions
  - isLoggingExceptions
```
default boolean isLoggingExceptions()
```
    Return true if the wrapper must log exceptions (default is false).
    
    Returns:
    
    true if the wrapper must log exceptions
  - err
```
default void err(java.lang.String message,
                 java.lang.Throwable e)
```
    Log an error, with a ErrorType.RUNTIME error type.
    
    Parameters:
    
    message - the error message
    
    e - the Throwable
  - err
```
void err(java.lang.String message,
         char errorType,
         java.lang.Throwable e)
```
    Log an error.
    
    Parameters:
    
    message - the error message
    
    errorType - the error type
    
    e - the Throwable
    
    See Also:
    
    ErrorType

Interface ScriptWrapper<S>

Field Summary

Method Summary

Methods inherited from interface org.scripthelper.model.ScriptMethodInvoker

Field Detail

MODE_BLOCKING

MODE_NON_BLOCKING

OPTIM_LEVEL_DEFAULT

OPTIM_LEVEL_MIN

OPTIM_LEVEL_MAX

Method Detail

isLibAvailable

isLibAvailable

getMIME

setExecutionMode

getExecutionMode

getOptimizationLevel

setOptimizationLevel

setClassLoader

getClassLoader

isMultiImplementSupported

isSingletonMethodEnabled

hasSingletonMethod

addExceptionListener

getExceptionListeners

removeExceptionListener

setScriptContext

getScriptContext

hasScriptHelper

getScriptContent

getRawScript

getScript

getScriptProxyHandler

getScriptProxy

getScriptProxy

getScriptInterface

getScriptClassName

getSource

getFilename

addImports

addImports

addImports

clearImports

addAdditionalHelper

getAdditionalHelpers

hasAdditionalHelpers

clearAdditionalHelpers

getOffset

countImportLines

getLineNumber

getLineNumber

getScriptExtension

getScriptException

setScriptLogger

installScript

installScript

installScript

installScript

reInstallScript

isDebugging

isInDebugSession

isDebugSupported

__step__

installScript

installScript

installScript

installScript

startMethod

resetWrapperState

logExceptions

isLoggingExceptions

err

err

step