org.apache.tinkerpop.gremlin.groovy.jsr223

Class ScriptEnginePluginAcceptor

java.lang.Object

org.apache.tinkerpop.gremlin.groovy.jsr223.ScriptEnginePluginAcceptor

All Implemented Interfaces:

PluginAcceptor

public class ScriptEnginePluginAcceptor
extends Object
implements PluginAcceptor

Author:

Stephen Mallette (http://stephen.genoprime.com)

Constructor Summary

Constructors

Constructor and Description
ScriptEnginePluginAcceptor(ScriptEngine scriptEngine)

Method Summary

Modifier and Type	Method and Description
void	addBinding(String key, Object val) Add a variable binding for the plugin host.
void	addImports(Set<String> importStatements) If the ScriptEngine implements the DependencyManager interface it will try to import the specified import statements.
Map<String,Object>	environment() Returns a map of implementation specific variables that can be referenced by the plugin.
Object	eval(String script) Evaluate a script in the ScriptEngine.
Map<String,Object>	getBindings() Gets the list of bindings from the plugin host.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptEnginePluginAcceptor

public ScriptEnginePluginAcceptor(ScriptEngine scriptEngine)

Method Detail

addBinding

public void addBinding(String key,
                       Object val)

Description copied from interface: PluginAcceptor

Add a variable binding for the plugin host.

Specified by:

addBinding in interface PluginAcceptor

getBindings

public Map<String,Object> getBindings()

Description copied from interface: PluginAcceptor

Gets the list of bindings from the plugin host. These bindings will represent the "global" binding list.

Specified by:

getBindings in interface PluginAcceptor

addImports

public void addImports(Set<String> importStatements)

If the ScriptEngine implements the DependencyManager interface it will try to import the specified import statements.

Specified by:

addImports in interface PluginAcceptor

eval

public Object eval(String script)
            throws ScriptException

Evaluate a script in the ScriptEngine. Typically eval() should be called after imports as ScriptEngine resets may occur during import.

Specified by:

eval in interface PluginAcceptor

Throws:

ScriptException

environment

public Map<String,Object> environment()

Description copied from interface: PluginAcceptor

Returns a map of implementation specific variables that can be referenced by the plugin. Those writing plugins should examine the details of the various PluginAcceptor implementations for the variables that they pass, as they may provide important information useful to the plugin itself.

Specified by:

environment in interface PluginAcceptor