Skip navigation links
A B C D E F G H I K L M N O P R S T U V W 

A

AbstractGremlinPlugin - Class in org.apache.tinkerpop.gremlin.groovy.plugin
A base class for a plugin that provides access to the shell and io variables.
AbstractGremlinPlugin() - Constructor for class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
Creates a new instance that does not force the plugin to require the console.
AbstractGremlinPlugin(boolean) - Constructor for class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
Creates a new instance that allows the plugin to specify whether the console is required or not.
AbstractImportCustomizerProvider - Class in org.apache.tinkerpop.gremlin.groovy
 
AbstractImportCustomizerProvider() - Constructor for class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
addBinding(String, Object) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.ScriptEnginePluginAcceptor
 
addBinding(String, Object) - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.PluginAcceptor
Add a variable binding for the plugin host.
addEngineSettings(String, List<String>, List<String>, List<String>, Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
Add a particular script engine for the executor to instantiate.
addImports(Set<String>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
Perform append to the existing import list for all ScriptEngine instances that implement the DependencyManager interface.
addImports(Set<String>) - Method in interface org.apache.tinkerpop.gremlin.groovy.jsr223.DependencyManager
Perform class imports for the ScriptEngine.
addImports(Set<String>) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
Perform class imports for the ScriptEngine.
addImports(Set<String>) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.ScriptEnginePluginAcceptor
If the ScriptEngine implements the DependencyManager interface it will try to import the specified import statements.
addImports(Set<String>) - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.PluginAcceptor
If the PluginAcceptor implements the DependencyManager interface it will try to import the specified import statements.
afterFailure(BiConsumer<Bindings, Throwable>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
A Consumer to execute in the event of failure.
afterFailure(BiConsumer<Bindings, Throwable>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle.Builder
Specifies the function to execute if the script evaluation fails.
afterPluginTo(PluginAcceptor) - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
Called after the AbstractGremlinPlugin.pluginTo(PluginAcceptor) method is executed which sets the AbstractGremlinPlugin.io and AbstractGremlinPlugin.shell member variables.
afterPluginTo(PluginAcceptor) - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraphGremlinPlugin
Called after the AbstractGremlinPlugin.pluginTo(PluginAcceptor) method is executed which sets the AbstractGremlinPlugin.io and AbstractGremlinPlugin.shell member variables.
afterPluginTo(PluginAcceptor) - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.SugarGremlinPlugin
Called after the AbstractGremlinPlugin.pluginTo(PluginAcceptor) method is executed which sets the AbstractGremlinPlugin.io and AbstractGremlinPlugin.shell member variables.
afterSuccess(Consumer<Bindings>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
A Consumer to execute just after successful script evaluation.
afterSuccess(Consumer<Bindings>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle.Builder
Specifies the function to execute after result transformations.
afterTimeout(Consumer<Bindings>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
A Consumer to execute if the script times out.
afterTimeout(Consumer<Bindings>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle.Builder
Specifies the function to execute if the script evaluation times out.
apply(A, A) - Method in class org.apache.tinkerpop.gremlin.groovy.function.GBinaryOperator
Deprecated.
 
apply(A) - Method in class org.apache.tinkerpop.gremlin.groovy.function.GFunction
Deprecated.
 
apply(A) - Method in class org.apache.tinkerpop.gremlin.groovy.function.GUnaryOperator
Deprecated.
 
Artifact - Class in org.apache.tinkerpop.gremlin.groovy.plugin
A software artifact identified by its maven coordinates.
Artifact(String, String, String) - Constructor for class org.apache.tinkerpop.gremlin.groovy.plugin.Artifact
Create a new instance.

B

beforeEval(Consumer<Bindings>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
A Consumer to execute just before the script evaluation.
beforeEval(Consumer<Bindings>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle.Builder
Specifies the function to execute prior to the script being evaluated.
build() - Static method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Create a Builder with the gremlin-groovy ScriptEngine configured.
build(String, List<String>, List<String>, List<String>, Map<String, Object>) - Static method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Create a Builder and specify the first ScriptEngine to be included.
build() - Static method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle
 
Builder() - Constructor for class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle.Builder
 

C

call(SourceUnit, GeneratorContext, ClassNode) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.VariableIdentificationCustomizer
 
clearVariables() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.VariableIdentificationCustomizer
 
close() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor

Executors are only closed if they were not supplied externally in the GremlinExecutor.Builder

close() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
Iterate through all the ScriptEngine implementations and if they implement AutoCloseable then call the AutoCloseable.close() method.
close() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
 
closeAsync() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Executors are only closed if they were not supplied externally in the GremlinExecutor.Builder
compare(A, A) - Method in class org.apache.tinkerpop.gremlin.groovy.function.GComparator
Deprecated.
 
compile(String) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Attempts to compile a script and cache it in the default ScriptEngine.
compile(String, Optional<String>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Attempts to compile a script and cache it in the request ScriptEngine.
compile(String, String) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
Compiles a script without executing it.
compile(Reader, String) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
Compiles a script without executing it.
compile(String) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
compile(Reader) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
COMPILE_OPTIONS - Static variable in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
 
COMPILE_OPTIONS_VAR_TYPES - Static variable in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
An "internal" key for sandboxing the script engine - technically not for public use.
CompilerCustomizerProvider - Interface in org.apache.tinkerpop.gremlin.groovy
Provides a way to plugin Groovy CompilationCustomizer implementations to the GremlinGroovyScriptEngine.
CompileStaticCustomizerProvider - Class in org.apache.tinkerpop.gremlin.groovy.jsr223.customizer
Injects the CompileStatic transformer to enable type validation on script execution.
CompileStaticCustomizerProvider() - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.CompileStaticCustomizerProvider
 
CompileStaticCustomizerProvider(String) - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.CompileStaticCustomizerProvider
 
configure(List<String>) - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.RemoteAcceptor
Gets called when :remote is used in conjunction with the config option.
connect(List<String>) - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.RemoteAcceptor
Gets called when :remote is used in conjunction with the "connect" option.
countUsers() - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraph
Get a count of the number of users in the database.
create() - Method in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
create() - Method in interface org.apache.tinkerpop.gremlin.groovy.CompilerCustomizerProvider
Create a new instance of a CompilationCustomizer to add to the GremlinGroovyScriptEngine.
create() - Method in class org.apache.tinkerpop.gremlin.groovy.EmptyImportCustomizerProvider
 
create() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
 
create() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle.Builder
 
create() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.CompileStaticCustomizerProvider
 
create() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.ThreadInterruptCustomizerProvider
 
create() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.TimedInterruptCustomizerProvider
 
create() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.TypeCheckedCustomizerProvider
 
create() - Method in class org.apache.tinkerpop.gremlin.groovy.NoImportCustomizerProvider
 
createBindings() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
Create bindings to be used by this ScriptEngine.
createUser(String, String) - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraph
Creates a new user.
CredentialGraph - Class in org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential
A DSL for managing a "credentials graph" used by Gremlin Server for simple authentication functions.
CredentialGraph(Graph) - Constructor for class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraph
 
CredentialGraphGremlinPlugin - Class in org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential
Plugin for the "credentials graph".
CredentialGraphGremlinPlugin() - Constructor for class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraphGremlinPlugin
 
CredentialGraphTokens - Class in org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential
 
credentials(Graph) - Static method in class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraph
Wrap up any Graph instance in the CredentialGraph DSL.

D

DEFAULT_INTERRUPTION_TIMEOUT - Static variable in class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.TimedInterruptCustomizerProvider
 
DefaultImportCustomizerProvider - Class in org.apache.tinkerpop.gremlin.groovy
Grabs the standard Gremlin core classes and allows additional imports to be added.
DefaultImportCustomizerProvider() - Constructor for class org.apache.tinkerpop.gremlin.groovy.DefaultImportCustomizerProvider
Utilizes imports defined statically by initializeStatically().
DefaultImportCustomizerProvider(Set<String>, Set<String>) - Constructor for class org.apache.tinkerpop.gremlin.groovy.DefaultImportCustomizerProvider
Utilizes imports defined by the supplied arguments.
DefaultImportCustomizerProvider(ImportCustomizerProvider, Set<String>, Set<String>) - Constructor for class org.apache.tinkerpop.gremlin.groovy.DefaultImportCustomizerProvider
Utilizes imports defined by the supplied arguments.
dependencies() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
List dependencies for those ScriptEngine objects that implement the DependencyManager interface.
dependencies() - Method in interface org.apache.tinkerpop.gremlin.groovy.jsr223.DependencyManager
List the dependencies in the ScriptEngine classloader.
dependencies() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
List the dependencies in the ScriptEngine classloader.
DependencyManager - Interface in org.apache.tinkerpop.gremlin.groovy.jsr223
Provides a way to dynamically consume dependencies into the ScriptEngine classloader.
DOT_STAR - Static variable in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
DOT_STAR - Static variable in class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
 

E

EMPTY_STRING - Static variable in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
EmptyImportCustomizerProvider - Class in org.apache.tinkerpop.gremlin.groovy
This ImportCustomizerProvider is empty and comes with no pre-defined imports at all.
EmptyImportCustomizerProvider(Set<String>, Set<String>) - Constructor for class org.apache.tinkerpop.gremlin.groovy.EmptyImportCustomizerProvider
Utilizes imports defined by the supplied arguments.
EmptyImportCustomizerProvider(ImportCustomizerProvider, Set<String>, Set<String>) - Constructor for class org.apache.tinkerpop.gremlin.groovy.EmptyImportCustomizerProvider
Utilizes imports defined by the supplied arguments.
enabledPlugins(Set<String>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
Set of the names of plugins that should be enabled for the engine.
engineSettings(Map<String, GremlinExecutor.EngineSettings>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
ENV_CONSOLE_IO - Static variable in class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
 
ENV_CONSOLE_SHELL - Static variable in class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
 
environment() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.ScriptEnginePluginAcceptor
 
ENVIRONMENT - Static variable in interface org.apache.tinkerpop.gremlin.groovy.plugin.GremlinPlugin
 
environment() - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.PluginAcceptor
Returns a map of implementation specific variables that can be referenced by the plugin.
equals(Object) - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.Artifact
 
eval(String) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Evaluate a script with empty bindings.
eval(String, Bindings) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Evaluate a script with specified bindings.
eval(String, Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Evaluate a script with a Map of bindings.
eval(String, String, Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Evaluate a script.
eval(String, String, Bindings) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Evaluate a script.
eval(String, String, Map<String, Object>, Function<Object, Object>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Evaluate a script and allow for the submission of a transform Function that will transform the result after script evaluates but before transaction commit and before the returned CompletableFuture is completed.
eval(String, String, Map<String, Object>, Consumer<Object>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Evaluate a script and allow for the submission of a Consumer that will take the result for additional processing after the script evaluates and after the CompletableFuture is completed, but before the transaction is committed.
eval(String, String, Bindings, Function<Object, Object>, Consumer<Object>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Evaluate a script and allow for the submission of both a transform Function and Consumer.
eval(String, String, Bindings, GremlinExecutor.LifeCycle) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
Evaluate a script and allow for the submission of alteration to the entire evaluation execution lifecycle.
eval(String, Bindings, String) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
Evaluate a script with Bindings for a particular language.
eval(Reader, Bindings, String) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
Evaluate a script with Bindings for a particular language.
eval(Reader, ScriptContext) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
eval(String, ScriptContext) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
eval(String) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.ScriptEnginePluginAcceptor
Evaluate a script in the ScriptEngine.
eval(String) - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.PluginAcceptor
Evaluate a script in the PluginAcceptor.
evaluate(Reader, List<String>) - Static method in class org.apache.tinkerpop.gremlin.groovy.jsr223.ScriptExecutor
 
executorService(ExecutorService) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
The thread pool used to evaluate scripts.
extraImports - Variable in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
extraStaticImports - Variable in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 

F

findUser(String) - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraph
Finds a user by username and return null if one could not be found.

G

GBinaryOperator<A> - Class in org.apache.tinkerpop.gremlin.groovy.function
Deprecated.
As of release 3.1.0, use as BinaryOperator in Groovy.
GBinaryOperator(Closure) - Constructor for class org.apache.tinkerpop.gremlin.groovy.function.GBinaryOperator
Deprecated.
 
GComparator<A> - Class in org.apache.tinkerpop.gremlin.groovy.function
Deprecated.
As of release 3.1.0, use as Comparator in Groovy.
GComparator(Closure) - Constructor for class org.apache.tinkerpop.gremlin.groovy.function.GComparator
Deprecated.
 
get() - Method in class org.apache.tinkerpop.gremlin.groovy.function.GSupplier
Deprecated.
 
getAfterFailure() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle
 
getAfterSuccess() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle
 
getAfterTimeout() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle
 
getAllImports() - Method in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
getAllImports() - Method in class org.apache.tinkerpop.gremlin.groovy.EmptyImportCustomizerProvider
 
getArtifact() - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.Artifact
 
getBeforeEval() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle
 
getBindings() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.ScriptEnginePluginAcceptor
 
getBindings() - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.PluginAcceptor
Gets the list of bindings from the plugin host.
getEngineName() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getEngineVersion() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getExecutorService() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
 
getExtensions() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getExtraImports() - Method in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
getExtraImports() - Method in interface org.apache.tinkerpop.gremlin.groovy.ImportCustomizerProvider
 
getExtraImports() - Method in class org.apache.tinkerpop.gremlin.groovy.NoImportCustomizerProvider
 
getExtraStaticImports() - Method in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
getExtraStaticImports() - Method in interface org.apache.tinkerpop.gremlin.groovy.ImportCustomizerProvider
 
getExtraStaticImports() - Method in class org.apache.tinkerpop.gremlin.groovy.NoImportCustomizerProvider
 
getFactory() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
getGlobalBindings() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
 
getGroup() - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.Artifact
 
getImports() - Method in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
getImports() - Method in class org.apache.tinkerpop.gremlin.groovy.EmptyImportCustomizerProvider
 
getImports() - Method in interface org.apache.tinkerpop.gremlin.groovy.ImportCustomizerProvider
 
getImports() - Method in class org.apache.tinkerpop.gremlin.groovy.NoImportCustomizerProvider
 
getInterface(Class<T>) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
 
getInterface(Object, Class<T>) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
 
getLanguageName() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getLanguageVersion() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getMethodCallSyntax(String, String, String...) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getMimeTypes() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getName() - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraphGremlinPlugin
 
getName() - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.GremlinPlugin
The name of the plugin.
getName() - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.SugarGremlinPlugin
 
getNames() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getOutputStatement(String) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getParameter(String) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getParentLoader() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
 
getPlugins() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
Get the list of loaded plugins.
getProgram(String...) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getScheduledExecutorService() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
 
getScript(String, Groovysh) - Static method in interface org.apache.tinkerpop.gremlin.groovy.plugin.RemoteAcceptor
Retrieve a script as defined in the shell context.
getScriptEngine() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
getScriptEngines() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor
 
getStaticImports() - Method in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
getStaticImports() - Method in class org.apache.tinkerpop.gremlin.groovy.EmptyImportCustomizerProvider
 
getStaticImports() - Method in interface org.apache.tinkerpop.gremlin.groovy.ImportCustomizerProvider
 
getStaticImports() - Method in class org.apache.tinkerpop.gremlin.groovy.NoImportCustomizerProvider
 
getTransformResult() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle
 
getVariables() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.VariableIdentificationCustomizer
 
getVersion() - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.Artifact
 
getWithResult() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle
 
GFunction<A,B> - Class in org.apache.tinkerpop.gremlin.groovy.function
Deprecated.
As of release 3.1.0, use as Function in Groovy.
GFunction(Closure) - Constructor for class org.apache.tinkerpop.gremlin.groovy.function.GFunction
Deprecated.
 
globalBindings(Bindings) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
Bindings to apply to every script evaluated.
GremlinExecutor - Class in org.apache.tinkerpop.gremlin.groovy.engine
Execute Gremlin scripts against a ScriptEngine instance.
GremlinExecutor.Builder - Class in org.apache.tinkerpop.gremlin.groovy.engine
 
GremlinExecutor.LifeCycle - Class in org.apache.tinkerpop.gremlin.groovy.engine
The lifecycle of execution within the GremlinExecutor.eval(String, String, Bindings, LifeCycle) method.
GremlinExecutor.LifeCycle.Builder - Class in org.apache.tinkerpop.gremlin.groovy.engine
 
GremlinGroovyScriptEngine - Class in org.apache.tinkerpop.gremlin.groovy.jsr223
Provides methods to compile and evaluate Gremlin scripts.
GremlinGroovyScriptEngine() - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
Creates a new instance using the DefaultImportCustomizerProvider.
GremlinGroovyScriptEngine(ImportCustomizerProvider) - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
GremlinGroovyScriptEngine(CompilerCustomizerProvider...) - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
Creates a new instance with the specified CompilerCustomizerProvider objects.
GremlinGroovyScriptEngineFactory - Class in org.apache.tinkerpop.gremlin.groovy.jsr223
 
GremlinGroovyScriptEngineFactory() - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineFactory
 
GremlinPlugin - Interface in org.apache.tinkerpop.gremlin.groovy.plugin
Those wanting to extend Gremlin can implement this interface to provide mapper imports and extension methods to the language itself.
GremlinPluginException - Exception in org.apache.tinkerpop.gremlin.groovy.plugin
Base exception for GremlinPlugin.
GremlinPluginException() - Constructor for exception org.apache.tinkerpop.gremlin.groovy.plugin.GremlinPluginException
 
GremlinPluginException(String) - Constructor for exception org.apache.tinkerpop.gremlin.groovy.plugin.GremlinPluginException
 
GremlinPluginException(String, Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.groovy.plugin.GremlinPluginException
 
GremlinPluginException(Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.groovy.plugin.GremlinPluginException
 
GSupplier<A> - Class in org.apache.tinkerpop.gremlin.groovy.function
Deprecated.
As of release 3.1.0, use as Supplier in Groovy.
GSupplier(Closure) - Constructor for class org.apache.tinkerpop.gremlin.groovy.function.GSupplier
Deprecated.
 
GUnaryOperator<A> - Class in org.apache.tinkerpop.gremlin.groovy.function
Deprecated.
As of release 3.1.0, use as UnaryOperator in Groovy.
GUnaryOperator(Closure) - Constructor for class org.apache.tinkerpop.gremlin.groovy.function.GUnaryOperator
Deprecated.
 

H

hashCode() - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.Artifact
 

I

IllegalEnvironmentException - Exception in org.apache.tinkerpop.gremlin.groovy.plugin
An exception thrown when the environment variables passed via PluginAcceptor.environment() do not meet the needs of the GremlinPlugin.
IllegalEnvironmentException(GremlinPlugin, String...) - Constructor for exception org.apache.tinkerpop.gremlin.groovy.plugin.IllegalEnvironmentException
 
IMPORT_SPACE - Static variable in class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
 
IMPORT_STATIC_SPACE - Static variable in class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
 
ImportCustomizerProvider - Interface in org.apache.tinkerpop.gremlin.groovy
Allows customization of the imports used by the GremlinGroovyScriptEngine implementation.
imports() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
List the imports for those ScriptEngine objects that implement the DependencyManager interface.
imports() - Method in interface org.apache.tinkerpop.gremlin.groovy.jsr223.DependencyManager
List the imports in the ScriptEngine;
imports() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
List the imports in the ScriptEngine;
initializeStatically(Set<String>, Set<String>) - Static method in class org.apache.tinkerpop.gremlin.groovy.DefaultImportCustomizerProvider
Allows imports to defined globally and statically.
INSTANCE - Static variable in class org.apache.tinkerpop.gremlin.groovy.NoImportCustomizerProvider
 
invokeFunction(String, Object...) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
 
invokeMethod(Object, String, Object...) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
 
io - Variable in class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
 

K

KEY_REFERENCE_TYPE - Static variable in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
The attribute key (passed as a binding on the context) for how to cache scripts.

L

loadPlugins(List<GremlinPlugin>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
For each DependencyManager try to load the specified plugins.
loadPlugins(List<GremlinPlugin>) - Method in interface org.apache.tinkerpop.gremlin.groovy.jsr223.DependencyManager
Load a list of GremlinPlugin instances.
loadPlugins(List<GremlinPlugin>) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
Load a list of GremlinPlugin instances.

M

main(String[]) - Static method in class org.apache.tinkerpop.gremlin.groovy.jsr223.ScriptExecutor
 
make(Closure...) - Static method in class org.apache.tinkerpop.gremlin.groovy.function.GBinaryOperator
Deprecated.
 
make(Closure...) - Static method in class org.apache.tinkerpop.gremlin.groovy.function.GComparator
Deprecated.
 
make(Closure...) - Static method in class org.apache.tinkerpop.gremlin.groovy.function.GFunction
Deprecated.
 
make(Closure...) - Static method in class org.apache.tinkerpop.gremlin.groovy.function.GSupplier
Deprecated.
 
make(Closure...) - Static method in class org.apache.tinkerpop.gremlin.groovy.function.GUnaryOperator
Deprecated.
 

N

NoImportCustomizerProvider - Class in org.apache.tinkerpop.gremlin.groovy
Provides no imports.

O

org.apache.tinkerpop.gremlin.groovy - package org.apache.tinkerpop.gremlin.groovy
 
org.apache.tinkerpop.gremlin.groovy.engine - package org.apache.tinkerpop.gremlin.groovy.engine
 
org.apache.tinkerpop.gremlin.groovy.function - package org.apache.tinkerpop.gremlin.groovy.function
 
org.apache.tinkerpop.gremlin.groovy.jsr223 - package org.apache.tinkerpop.gremlin.groovy.jsr223
 
org.apache.tinkerpop.gremlin.groovy.jsr223.customizer - package org.apache.tinkerpop.gremlin.groovy.jsr223.customizer
 
org.apache.tinkerpop.gremlin.groovy.plugin - package org.apache.tinkerpop.gremlin.groovy.plugin
 
org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential - package org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential
 

P

PERIOD - Static variable in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
PluginAcceptor - Interface in org.apache.tinkerpop.gremlin.groovy.plugin
A GremlinPlugin can be used in multiple environments (e.g.
PluginInitializationException - Exception in org.apache.tinkerpop.gremlin.groovy.plugin
An exception that occurs as a result of plugin initialization, typically triggered by a bad evaluation in the ScriptEngine.
PluginInitializationException(String) - Constructor for exception org.apache.tinkerpop.gremlin.groovy.plugin.PluginInitializationException
 
PluginInitializationException(String, Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.groovy.plugin.PluginInitializationException
 
PluginInitializationException(Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.groovy.plugin.PluginInitializationException
 
plugins() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
Deprecated.
As of release 3.0.1, replaced by GremlinGroovyScriptEngine.getPlugins()
pluginTo(PluginAcceptor) - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
Implementers will typically execute imports of classes within their project that they want available in the console or they may use meta programming to introduce new extensions to the Gremlin.
pluginTo(PluginAcceptor) - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.GremlinPlugin
Implementers will typically execute imports of classes within their project that they want available in the console or they may use meta programming to introduce new extensions to the Gremlin.
processImports(ImportCustomizer, Set<String>) - Static method in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
processStaticImports(ImportCustomizer, Set<String>) - Static method in class org.apache.tinkerpop.gremlin.groovy.AbstractImportCustomizerProvider
 
PROPERTY_PASSWORD - Static variable in class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraphTokens
 
PROPERTY_USERNAME - Static variable in class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraphTokens
 

R

REFERENCE_TYPE_HARD - Static variable in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
A value to the GremlinGroovyScriptEngine.KEY_REFERENCE_TYPE that makes the evaluated script available in the cache for the life of the JVM.
REFERENCE_TYPE_PHANTOM - Static variable in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
A value to the GremlinGroovyScriptEngine.KEY_REFERENCE_TYPE that immediately garbage collects the script after evaluation.
REFERENCE_TYPE_SOFT - Static variable in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
A value to the GremlinGroovyScriptEngine.KEY_REFERENCE_TYPE that retains the script until memory is "low" and therefore should be reclaimed before an OutOfMemoryError occurs.
REFERENCE_TYPE_WEAK - Static variable in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
A value to the GremlinGroovyScriptEngine.KEY_REFERENCE_TYPE that marks the script as one that can be garbage collected even when memory is abundant.
reload(String, Set<String>, Set<String>, Map<String, Object>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
Reload a ScriptEngine with fresh imports.
remoteAcceptor() - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.GremlinPlugin
Allows a plugin to utilize features of the :remote and :submit commands of the Gremlin Console.
RemoteAcceptor - Interface in org.apache.tinkerpop.gremlin.groovy.plugin
The Gremlin Console supports the :remote and :submit commands which provide standardized ways for plugins to provide "remote connections" to resources and a way to "submit" a command to those resources.
RemoteException - Exception in org.apache.tinkerpop.gremlin.groovy.plugin
A mapper Exception to be thrown when there are problems with processing a command given to a RemoteAcceptor.
RemoteException(String) - Constructor for exception org.apache.tinkerpop.gremlin.groovy.plugin.RemoteException
 
RemoteException(String, Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.groovy.plugin.RemoteException
 
RemoteException(Throwable) - Constructor for exception org.apache.tinkerpop.gremlin.groovy.plugin.RemoteException
 
removeUser(String) - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraph
Removes a user by name.
requireConsoleEnvironment - Variable in class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
 
requireRestart() - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.GremlinPlugin
Some plugins may require a restart of the plugin host for the classloader to pick up the features.
reset() - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
Resets the ScriptEngines and re-initializes them.
reset() - Method in interface org.apache.tinkerpop.gremlin.groovy.jsr223.DependencyManager
Reset the ScriptEngine.
reset() - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
Reset the ScriptEngine.
RESULT - Static variable in interface org.apache.tinkerpop.gremlin.groovy.plugin.RemoteAcceptor
 

S

scheduledExecutorService(ScheduledExecutorService) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
The thread pool used to schedule timeouts on scripts.
ScriptEnginePluginAcceptor - Class in org.apache.tinkerpop.gremlin.groovy.jsr223
 
ScriptEnginePluginAcceptor(ScriptEngine) - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.ScriptEnginePluginAcceptor
 
ScriptEngines - Class in org.apache.tinkerpop.gremlin.groovy.engine
Holds a batch of the configured ScriptEngine objects for the server.
ScriptEngines(Consumer<ScriptEngines>) - Constructor for class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
Creates a new object.
scriptEvaluationTimeout(long) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
Amount of time a script has before it times out.
ScriptExecutor - Class in org.apache.tinkerpop.gremlin.groovy.jsr223
Executes a Gremlin script from the command line.
ScriptExecutor() - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.ScriptExecutor
 
shell - Variable in class org.apache.tinkerpop.gremlin.groovy.plugin.AbstractGremlinPlugin
 
submit(List<String>) - Method in interface org.apache.tinkerpop.gremlin.groovy.plugin.RemoteAcceptor
Gets called when :submit is executed.
SugarGremlinPlugin - Class in org.apache.tinkerpop.gremlin.groovy.plugin
A plugin implementation which allows for the usage of Gremlin Groovy's syntactic sugar.
SugarGremlinPlugin() - Constructor for class org.apache.tinkerpop.gremlin.groovy.plugin.SugarGremlinPlugin
 

T

ThreadInterruptCustomizerProvider - Class in org.apache.tinkerpop.gremlin.groovy.jsr223.customizer
Injects checks for thread interruption into scripts.
ThreadInterruptCustomizerProvider() - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.ThreadInterruptCustomizerProvider
 
TimedInterruptCustomizerProvider - Class in org.apache.tinkerpop.gremlin.groovy.jsr223.customizer
Injects a check in loops and other areas of code to interrupt script execution if the run time exceeds the specified time.
TimedInterruptCustomizerProvider() - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.TimedInterruptCustomizerProvider
 
TimedInterruptCustomizerProvider(Long) - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.TimedInterruptCustomizerProvider
 
TimedInterruptCustomizerProvider(Integer) - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.TimedInterruptCustomizerProvider
 
toString() - Method in class org.apache.tinkerpop.gremlin.groovy.function.GBinaryOperator
Deprecated.
 
toString() - Method in class org.apache.tinkerpop.gremlin.groovy.function.GComparator
Deprecated.
 
toString() - Method in class org.apache.tinkerpop.gremlin.groovy.function.GFunction
Deprecated.
 
toString() - Method in class org.apache.tinkerpop.gremlin.groovy.function.GSupplier
Deprecated.
 
toString() - Method in class org.apache.tinkerpop.gremlin.groovy.function.GUnaryOperator
Deprecated.
 
toString() - Method in class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraph
 
transformResult(Function<Object, Object>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle.Builder
Specifies the function to execute on the result of the script evaluation just after script evaluation returns but before the script evaluation is marked as complete.
TypeCheckedCustomizerProvider - Class in org.apache.tinkerpop.gremlin.groovy.jsr223.customizer
Injects the TypeChecked transformer to enable type validation on script execution.
TypeCheckedCustomizerProvider() - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.TypeCheckedCustomizerProvider
 
TypeCheckedCustomizerProvider(String) - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.TypeCheckedCustomizerProvider
Configures the TypeChecked annotation to use optional extensions.

U

use(List<List<String>>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.Builder
A set of maven coordinates for dependencies to be applied for the script engine instances.
use(String, String, String) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.ScriptEngines
Pull in dependencies given some Maven coordinates.
use(String, String, String) - Method in interface org.apache.tinkerpop.gremlin.groovy.jsr223.DependencyManager
Take maven coordinates and load the classes into the classloader used by the ScriptEngine.
use(String, String, String) - Method in class org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngine
Take maven coordinates and load the classes into the classloader used by the ScriptEngine.

V

VariableIdentificationCustomizer - Class in org.apache.tinkerpop.gremlin.groovy.jsr223.customizer
 
VariableIdentificationCustomizer() - Constructor for class org.apache.tinkerpop.gremlin.groovy.jsr223.customizer.VariableIdentificationCustomizer
 
VERTEX_LABEL_USER - Static variable in class org.apache.tinkerpop.gremlin.groovy.plugin.dsl.credential.CredentialGraphTokens
 

W

withResult(Consumer<Object>) - Method in class org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutor.LifeCycle.Builder
Specifies the function to execute on the result of the script evaluation just after script evaluation returns but after the script evaluation is marked as complete.
A B C D E F G H I K L M N O P R S T U V W 
Skip navigation links

Copyright © 2013–2015 Apache Software Foundation. All rights reserved.