Class AbstractGremlinPlugin
- java.lang.Object
-
- org.apache.tinkerpop.gremlin.jsr223.AbstractGremlinPlugin
-
- All Implemented Interfaces:
GremlinPlugin
- Direct Known Subclasses:
BindingsGremlinPlugin
,CredentialGraphGremlinPlugin
,GremlinServerGremlinPlugin
,GroovyCompilerGremlinPlugin
,ImportGremlinPlugin
,ScriptFileGremlinPlugin
,SugarGremlinPlugin
,TinkerGraphGremlinPlugin
public abstract class AbstractGremlinPlugin extends Object implements GremlinPlugin
- Author:
- Stephen Mallette (http://stephen.genoprime.com)
-
-
Field Summary
Fields Modifier and Type Field Description protected Set<String>
appliesTo
protected Customizer[]
customizers
protected String
moduleName
-
Constructor Summary
Constructors Constructor Description AbstractGremlinPlugin(String moduleName, Set<String> appliesTo, Customizer... customizers)
Creates a baseGremlinPlugin
that will apply to specificGremlinScriptEngine
instances.AbstractGremlinPlugin(String moduleName, Customizer... customizers)
Creates a baseGremlinPlugin
that will apply to allGremlinScriptEngine
instances.
-
Method Summary
All 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.-
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
-
-
-
-
Field Detail
-
moduleName
protected final String moduleName
-
customizers
protected final Customizer[] customizers
-
-
Constructor Detail
-
AbstractGremlinPlugin
public AbstractGremlinPlugin(String moduleName, Customizer... customizers)
Creates a baseGremlinPlugin
that will apply to allGremlinScriptEngine
instances.
-
AbstractGremlinPlugin
public AbstractGremlinPlugin(String moduleName, Set<String> appliesTo, Customizer... customizers)
Creates a baseGremlinPlugin
that will apply to specificGremlinScriptEngine
instances.
-
-
Method Detail
-
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
-
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
-
-