Class CoreGremlinPlugin
- java.lang.Object
-
- org.apache.tinkerpop.gremlin.jsr223.CoreGremlinPlugin
-
- All Implemented Interfaces:
GremlinPlugin
public final class CoreGremlinPlugin extends Object implements GremlinPlugin
This module is required for aScriptEngine
to be Gremlin-enabled. ThisGremlinPlugin
is not enabled for theServiceLoader
. It is designed to be instantiated manually and compliantGremlinScriptEngine
instances will automatically install it by default when created.- Author:
- Stephen Mallette (http://stephen.genoprime.com)
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Optional<Customizer[]>
getCustomizers(String scriptEngineName)
Gets the list ofCustomizer
implementations to assign to a newGremlinScriptEngine
.String
getName()
The name of the module.static CoreGremlinPlugin
instance()
-
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
-
-
-
-
Method Detail
-
instance
public static CoreGremlinPlugin instance()
-
getCustomizers
public Optional<Customizer[]> getCustomizers(String scriptEngineName)
Description copied from interface:GremlinPlugin
Gets the list ofCustomizer
implementations to assign to a newGremlinScriptEngine
. The implementation should filter the returnedCustomizers
according to the supplied name of the Gremlin-enabledScriptEngine
. By providing a filter,GremlinModule
developers can have the ability to target specificScriptEngines
.- Specified by:
getCustomizers
in interfaceGremlinPlugin
- Parameters:
scriptEngineName
- The name of theScriptEngine
or null to get all the availableCustomizers
-
getName
public String getName()
Description copied from interface:GremlinPlugin
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 Spark would be named "tinkerpop.spark". If Facebook were to do their own implementation the implementation might be called "facebook.spark".- Specified by:
getName
in interfaceGremlinPlugin
-
-