tinkerpop-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From spmalle...@apache.org
Subject [1/9] incubator-tinkerpop git commit: Update javadoc on base class for plugins.
Date Thu, 01 Oct 2015 16:54:04 GMT
Repository: incubator-tinkerpop
Updated Branches:
  refs/heads/master afb349ee7 -> 8eb5f09e2


Update javadoc on base class for plugins.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/63ec84c3
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/63ec84c3
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/63ec84c3

Branch: refs/heads/master
Commit: 63ec84c369efa19f46ec41b48abdefb2c96f0f28
Parents: 7198cfb
Author: Stephen Mallette <spmva@genoprime.com>
Authored: Thu Oct 1 08:57:39 2015 -0400
Committer: Stephen Mallette <spmva@genoprime.com>
Committed: Thu Oct 1 08:57:39 2015 -0400

----------------------------------------------------------------------
 .../gremlin/groovy/plugin/AbstractGremlinPlugin.java     | 11 +++++++++++
 1 file changed, 11 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/63ec84c3/gremlin-groovy/src/main/java/org/apache/tinkerpop/gremlin/groovy/plugin/AbstractGremlinPlugin.java
----------------------------------------------------------------------
diff --git a/gremlin-groovy/src/main/java/org/apache/tinkerpop/gremlin/groovy/plugin/AbstractGremlinPlugin.java
b/gremlin-groovy/src/main/java/org/apache/tinkerpop/gremlin/groovy/plugin/AbstractGremlinPlugin.java
index 08038ef..fcc8d05 100644
--- a/gremlin-groovy/src/main/java/org/apache/tinkerpop/gremlin/groovy/plugin/AbstractGremlinPlugin.java
+++ b/gremlin-groovy/src/main/java/org/apache/tinkerpop/gremlin/groovy/plugin/AbstractGremlinPlugin.java
@@ -43,10 +43,21 @@ public abstract class AbstractGremlinPlugin implements GremlinPlugin {
     protected Groovysh shell;
     protected final boolean requireConsoleEnvironment;
 
+    /**
+     * Creates a new instance that does not force the plugin to require the console.  This
will create a plugin that
+     * will work in Gremlin Console and Gremlin Server.
+     */
     public AbstractGremlinPlugin() {
         this(false);
     }
 
+    /**
+     * Creates a new instance that allows the plugin to specify whether the console is required
or not.  It is only
+     * necessary to require the console if there are specific required calls to {@code IO}
or to {@code Groovysh}
+     * methods in the plugin (as those classes are Gremlin Console related and cannot be
provided outside of that
+     * environment).  For a plugin to work in the Gremlin Console and in Gremlin Server this
value must be set
+     * to {@code false}.
+     */
     public AbstractGremlinPlugin(final boolean requireConsoleEnvironment) {
         this.requireConsoleEnvironment = requireConsoleEnvironment;
     }


Mime
View raw message