org.apache.tinkerpop.gremlin.jsr223

Class BindingsGremlinPlugin

java.lang.Object

org.apache.tinkerpop.gremlin.jsr223.AbstractGremlinPlugin

org.apache.tinkerpop.gremlin.jsr223.BindingsGremlinPlugin

All Implemented Interfaces:

GremlinPlugin

public class BindingsGremlinPlugin
extends AbstractGremlinPlugin

A module that allows Bindings to be applied to a GremlinScriptEngine. The bindings are controled by their scope which are determined by the ScriptContext values where "100" is ENGINE_SCOPE (bindings apply to the current GremlinScriptEngine) and "200" is GLOBAL_SCOPE (bindings apply to the engines created by the current GremlinScriptEngineManager.

Note that bindings are applied in the following order:

1. The order in which the GremlinScriptEngine is requested from the GremlinScriptEngineManager
2. The order in which the BindingsGremlinPlugin instances are added to the GremlinScriptEngineManager

Moreover, they will override one another within a scope and among scopes. For instance, ENGINE_SCOPE bindings will override GLOBAL_SCOPE. Those bindings that are GLOBAL_SCOPE and applied to a single GremlinScriptEngine via an BindingsGremlinPlugin.Builder.appliesTo configuration will still appear present to all other GremlinScriptEngine created by the GremlinScriptEngineManager that the plugin was bound to.

This GremlinPlugin is not enabled for the ServiceLoader. It is designed to be instantiated manually.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BindingsGremlinPlugin.Builder

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.jsr223.AbstractGremlinPlugin

appliesTo, customizers, moduleName

Constructor Summary

Constructors

Constructor and Description
BindingsGremlinPlugin(Bindings bindings, int scope)
BindingsGremlinPlugin(Supplier<Bindings> bindingsSupplier, int scope)

Method Summary

Modifier and Type	Method and Description
static BindingsGremlinPlugin.Builder	build()

Methods inherited from class org.apache.tinkerpop.gremlin.jsr223.AbstractGremlinPlugin

getCustomizers, getName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tinkerpop.gremlin.jsr223.GremlinPlugin

getCustomizers, requireRestart

Constructor Detail

BindingsGremlinPlugin

public BindingsGremlinPlugin(Bindings bindings,
                             int scope)

BindingsGremlinPlugin

public BindingsGremlinPlugin(Supplier<Bindings> bindingsSupplier,
                             int scope)

Method Detail

build

public static BindingsGremlinPlugin.Builder build()