Package org.apache.tinkerpop.gremlin.jsr223

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 a ScriptEngine to be Gremlin-enabled. This GremlinPlugin is not enabled for the ServiceLoader. It is designed to be instantiated manually and compliant GremlinScriptEngine instances will automatically install it by default when created.
Author:
Stephen Mallette (http://stephen.genoprime.com)

  • Method Details

    • instance

      public static CoreGremlinPlugin instance()

    • getCustomizers

      public Optional<Customizer[]> getCustomizers(String scriptEngineName)
      Description copied from interface: GremlinPlugin
      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 GremlinPlugin
      Parameters:
      scriptEngineName - The name of the ScriptEngine or null to get all the available Customizers

    • 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 interface GremlinPlugin