org.rvpf.script

Class ScriptEngineDriver

Object

ScriptEngineDriver

public final class ScriptEngineDriver
extends Object

Script engine driver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScriptEngineDriver.CompileTask Compile task.
static class	ScriptEngineDriver.EvalTask Eval task.
static class	ScriptEngineDriver.ExecuteException Execute exception.
static class	ScriptEngineDriver.Task Task.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ENGINE_NAME Default engine name.

Method Summary

Modifier and Type	Method and Description
void	bind(Map<String,Object> bindings) Binds all from additional bindings.
void	bind(String key, Object value) Binds a key to a value.
Optional<Object>	bound(String key) Returns the bound value for a key.
ScriptEngineFactory	getEngineFactory() Gets the script engine.
boolean	isRunning() Asks if running.
static ScriptEngineDriver	newInstance(Optional<String> optionalEngineName) Returns a new instance.
void	start(String threadName) Starts the background thread.
void	stop() Stops the background thread.
boolean	submit(ScriptEngineDriver.Task task) Submits a task.
void	unbind(Map<String,Object> bindings) Unbinds all from additional bindings.
void	unbind(String key) Unbinds a key.

Methods inherited from class Object

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

Field Detail

DEFAULT_ENGINE_NAME

public static final String DEFAULT_ENGINE_NAME

Default engine name.

See Also:

Constant Field Values

Method Detail

newInstance

@Nullable
 @CheckReturnValue
public static ScriptEngineDriver newInstance(@Nonnull
                                                                            Optional<String> optionalEngineName)

Returns a new instance.

Parameters:

optionalEngineName - The optional engine name.

Returns:

The new instance (null on failure).

bind

public void bind(@Nonnull
                 Map<String,Object> bindings)

Binds all from additional bindings.

Parameters:

bindings - The bindings to be added.

bind

public void bind(@Nonnull
                 String key,
                 @Nonnull
                 Object value)

Binds a key to a value.

Parameters:

key - The key.

value - The value.

bound

@Nonnull
 @CheckReturnValue
public Optional<Object> bound(@Nonnull
                                                            String key)

Returns the bound value for a key.

Parameters:

key - The key.

Returns:

The bound value (empty if none).

getEngineFactory

@Nonnull
 @CheckReturnValue
public ScriptEngineFactory getEngineFactory()

Gets the script engine.

Returns:

The script engine.

isRunning

@CheckReturnValue
public boolean isRunning()

Asks if running.

Returns:

True if running.

start

public void start(@Nonnull
                  String threadName)

Starts the background thread.

Parameters:

threadName - The name of the thread.

stop

public void stop()

Stops the background thread.

submit

@CheckReturnValue
public boolean submit(@Nonnull
                                         ScriptEngineDriver.Task task)

Submits a task.

Parameters:

task - The task.

Returns:

True on success.

unbind

public void unbind(@Nonnull
                   Map<String,Object> bindings)

Unbinds all from additional bindings.

Parameters:

bindings - The bindings to be removed.

unbind

public void unbind(@Nonnull
                   String key)

Unbinds a key.

Parameters:

key - The key.