org.apache.tinkerpop.gremlin.jsr223

Class CoreGremlinModule

java.lang.Object

org.apache.tinkerpop.gremlin.jsr223.CoreGremlinModule

All Implemented Interfaces:

GremlinModule

public class CoreGremlinModule
extends Object
implements GremlinModule

This module is required for a ScriptEngine to be Gremlin-enabled.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static CoreGremlinModule	INSTANCE

Method Summary

Modifier and Type	Method and Description
Optional<Customizer[]>	getCustomizers(String scriptEngineName) Gets the list of Customizer implementations to assign to a new GremlinScriptEngine.
String	getName() The name of the module.

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.GremlinModule

getCustomizers, requireRestart

Field Detail

INSTANCE

public static final CoreGremlinModule INSTANCE

Method Detail

getCustomizers

public Optional<Customizer[]> getCustomizers(String scriptEngineName)

Description copied from interface: GremlinModule

Gets the list of Customizer implementations to assign to a new GremlinScriptEngine. The implementation should filter the returned Customizers according to the supplied name of the Gremlin-enabled ScriptEngine. By providing a filter, GremlinModule developers can have the ability to target specific ScriptEngines.

Specified by:

getCustomizers in interface GremlinModule

Parameters:

scriptEngineName - The name of the ScriptEngine or null to get all the available Customizers

getName

public String getName()

Description copied from interface: GremlinModule

The name of the module. This name should be unique (use a namespaced approach) as naming clashes will prevent proper module operations. Modules developed by TinkerPop will be prefixed with "tinkerpop." For example, TinkerPop's implementation of Giraph would be named "tinkerpop.giraph". If Facebook were to do their own implementation the implementation might be called "facebook.giraph".

Specified by:

getName in interface GremlinModule