Repository: tinkerpop Updated Branches: refs/heads/TINKERPOP-1278 073910598 -> 9d8363e62
Add some javadoc to GremlinScriptEngine classes. Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/9d8363e6 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/9d8363e6 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/9d8363e6 Branch: refs/heads/TINKERPOP-1278 Commit: 9d8363e62d8b3cea294a33e8c410aac341f03804 Parents: 0739105 Author: Stephen Mallette <sp...@genoprime.com> Authored: Mon Jul 11 13:31:39 2016 -0400 Committer: Stephen Mallette <sp...@genoprime.com> Committed: Mon Jul 11 13:31:39 2016 -0400 ---------------------------------------------------------------------- .../apache/tinkerpop/gremlin/jsr223/Customizer.java | 1 + .../tinkerpop/gremlin/jsr223/CustomizerManager.java | 6 ++++++ .../gremlin/jsr223/GremlinScriptEngineFactory.java | 13 +++++++++++++ .../tinkerpop/gremlin/jsr223/ImportCustomizer.java | 2 ++ 4 files changed, 22 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/9d8363e6/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/Customizer.java ---------------------------------------------------------------------- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/Customizer.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/Customizer.java index 5c587e7..60dc810 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/Customizer.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/Customizer.java @@ -19,6 +19,7 @@ package org.apache.tinkerpop.gremlin.jsr223; /** + * The {@code Customizer} provides a general way to provide configurations to a {@link GremlinScriptEngine}. * * @author Stephen Mallette (http://stephen.genoprime.com) */ http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/9d8363e6/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/CustomizerManager.java ---------------------------------------------------------------------- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/CustomizerManager.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/CustomizerManager.java index 6511e4a..bcaeee4 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/CustomizerManager.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/CustomizerManager.java @@ -21,8 +21,14 @@ package org.apache.tinkerpop.gremlin.jsr223; import java.util.Optional; /** + * Holds the list of {@link Customizer} implementations that will be supplied to the {@link GremlinScriptEngine} when + * it is created. + * * @author Stephen Mallette (http://stephen.genoprime.com) */ public interface CustomizerManager { + /** + * Gets the list of {@link Customizer} implementations to assign to a new {@link GremlinScriptEngine}. + */ public Optional<Customizer[]> getCustomizers(); } http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/9d8363e6/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/GremlinScriptEngineFactory.java ---------------------------------------------------------------------- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/GremlinScriptEngineFactory.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/GremlinScriptEngineFactory.java index d627a91..9b4919d 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/GremlinScriptEngineFactory.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/GremlinScriptEngineFactory.java @@ -21,11 +21,24 @@ package org.apache.tinkerpop.gremlin.jsr223; import javax.script.ScriptEngineFactory; /** + * Creates a {@link GremlinScriptEngine} implementation and supplies to it any {@link Customizer} implementations to + * it that are available on the {@link CustomizerManager}. + * * @author Stephen Mallette (http://stephen.genoprime.com) */ public interface GremlinScriptEngineFactory extends ScriptEngineFactory { + + /** + * Creates a new {@link GremlinScriptEngine} instance. Unlike the JSR-223 implementation, the semantics for this + * interface expect a "new" instance to be created for each call to this method. Caching or pooling is something + * to be handled by a {@link GremlinScriptEngineManager}. + */ @Override GremlinScriptEngine getScriptEngine(); + /** + * The factory should take the {@link Customizer} implementations made available by the manager and supply them + * to the {@link GremlinScriptEngine} implementation it creates. + */ void setCustomizerManager(final CustomizerManager manager); } http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/9d8363e6/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/ImportCustomizer.java ---------------------------------------------------------------------- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/ImportCustomizer.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/ImportCustomizer.java index 39caa39..6070839 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/ImportCustomizer.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/jsr223/ImportCustomizer.java @@ -28,6 +28,8 @@ import java.util.HashSet; import java.util.Set; /** + * Provides the list of imports to apply to a {@link GremlinScriptEngine} instance. + * * @author Stephen Mallette (http://stephen.genoprime.com) */ public class ImportCustomizer implements Customizer {
