org.apache.tinkerpop.gremlin.groovy.plugin

Interface PluginAcceptor

All Known Implementing Classes:

ScriptEnginePluginAcceptor, TestableConsolePluginAcceptor

public interface PluginAcceptor

A GremlinPlugin can be used in multiple environments (e.g. ScriptEngine implementation). Any environment wishing to allow plugins should implement the PluginAcceptor. It acts as an adapter to those environments and provides the abstractions required for a plugin to work regardless of the environmental implementations.

Author:

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

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 PluginAcceptor implements the DependencyManager interface it will try to import the specified import statements.
default 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 PluginAcceptor.
Map<String,Object>	getBindings() Gets the list of bindings from the plugin host.

Method Detail

addImports

void addImports(Set<String> importStatements)

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

addBinding

void addBinding(String key,
                Object val)

Add a variable binding for the plugin host.

getBindings

Map<String,Object> getBindings()

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

eval

Object eval(String script)
     throws ScriptException

Evaluate a script in the PluginAcceptor.

Throws:

ScriptException

environment

default Map<String,Object> environment()

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.