Repository: tinkerpop Updated Branches: refs/heads/TINKERPOP-1975-x 25e219fe9 -> 4e64e0662
wip Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/4e64e066 Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/4e64e066 Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/4e64e066 Branch: refs/heads/TINKERPOP-1975-x Commit: 4e64e0662af12f6551fcf076ce5c40a626a5df44 Parents: 25e219f Author: Stephen Mallette <[email protected]> Authored: Thu May 31 13:58:31 2018 -0400 Committer: Stephen Mallette <[email protected]> Committed: Thu May 31 13:58:31 2018 -0400 ---------------------------------------------------------------------- .../gremlin/process/traversal/step/Configuring.java | 15 +++++++++++++++ .../process/traversal/step/Parameterizing.java | 3 ++- 2 files changed, 17 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/4e64e066/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Configuring.java ---------------------------------------------------------------------- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Configuring.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Configuring.java index 4297ca9..4ac6280 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Configuring.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Configuring.java @@ -18,9 +18,24 @@ */ package org.apache.tinkerpop.gremlin.process.traversal.step; +import org.apache.tinkerpop.gremlin.process.traversal.Step; +import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal; +import org.apache.tinkerpop.gremlin.process.traversal.step.util.Parameters; + /** + * Identifies a {@link Step} as one that can accept configurations via the {@link GraphTraversal#with(String, Object)} + * step modulator. The nature of the configuration allowed is specific to the implementation. + * * @author Stephen Mallette (http://stephen.genoprime.com) */ public interface Configuring extends Parameterizing { + + /** + * Accept a configuration to the {@link Step}. Note that this interface extends {@link Parameterizing} and so + * there is an expectation that the {@link Step} implementation will have a {@link Parameters} instance that will + * house any values passed to this method. Storing these configurations in {@link Parameters} is not a requirement + * however, IF the configuration is an expected option for the step and can be stored on a member field that can + * be accessed on the step by more direct means (i.e. like a getter method). + */ public void configure(final Object... keyValues); } http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/4e64e066/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Parameterizing.java ---------------------------------------------------------------------- diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Parameterizing.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Parameterizing.java index a4d27aa..9d8dc22 100644 --- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Parameterizing.java +++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Parameterizing.java @@ -24,7 +24,8 @@ import org.apache.tinkerpop.gremlin.process.traversal.step.util.Parameters; /** * An interface for {@link Step} implementations that hold a {@link Parameters} object, which fold in arguments from * other steps. It is typically used on mutating steps, such as {@code addV()}, where calls to {@code property(k,v)} - * are folded in as parameters to that add vertex step. + * are folded in as parameters to that add vertex step, but it may be used for any step that could benefit from + * modulation. * * @author Marko A. Rodriguez (http://markorodriguez.com) * @author Stephen Mallette (http://stephen.genoprime.com)
