You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/03/13 22:24:56 UTC

incubator-tinkerpop git commit: Add javadoc to GraphProvider for the traversal() method.

Repository: incubator-tinkerpop
Updated Branches:
  refs/heads/master 1c44895e8 -> 954e1fdb8


Add javadoc to GraphProvider for the traversal() method.


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

Branch: refs/heads/master
Commit: 954e1fdb82ad8b6ff2249980ccb1299d62c15567
Parents: 1c44895
Author: Stephen Mallette <sp...@apache.org>
Authored: Fri Mar 13 17:24:35 2015 -0400
Committer: Stephen Mallette <sp...@apache.org>
Committed: Fri Mar 13 17:24:35 2015 -0400

----------------------------------------------------------------------
 .../org/apache/tinkerpop/gremlin/GraphProvider.java | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/954e1fdb/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/GraphProvider.java
----------------------------------------------------------------------
diff --git a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/GraphProvider.java b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/GraphProvider.java
index 3a6c34b..75e92f9 100644
--- a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/GraphProvider.java
+++ b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/GraphProvider.java
@@ -77,10 +77,26 @@ public interface GraphProvider {
         add(O_Traverser.class);
     }};
 
+    /**
+     * Create a {@link GraphTraversalContext} from a {@link Graph} instance.  The default implementation uses the
+     * {@link org.apache.tinkerpop.gremlin.process.traversal.engine.StandardTraversalEngine} so vendors should
+     * override as necessary if their implementation is testing something that requires a different engine type,
+     * like those tests for {@link org.apache.tinkerpop.gremlin.process.TraversalEngine.Type}.
+     */
     public default GraphTraversalContext traversal(final Graph graph) {
         return GraphTraversalContext.build().engine(StandardTraversalEngine.build()).create(graph);
     }
 
+    /**
+     * Create a {@link GraphTraversalContext} from a {@link Graph} instance.  The default implementation uses the
+     * {@link org.apache.tinkerpop.gremlin.process.traversal.engine.StandardTraversalEngine} so vendors should
+     * override as necessary if their implementation is testing something that requires a different engine type,
+     * like those tests for {@link org.apache.tinkerpop.gremlin.process.TraversalEngine.Type}.
+     * <br/>
+     * Implementations should apply strategies as necessary to the
+     * {@link org.apache.tinkerpop.gremlin.process.graph.traversal.GraphTraversalContext.Builder} before calling
+     * it's {@code create} method.
+     */
     public default GraphTraversalContext traversal(final Graph graph, final TraversalStrategy... strategies) {
         final GraphTraversalContext.Builder builder = GraphTraversalContext.build().engine(StandardTraversalEngine.build());
         Stream.of(strategies).forEach(builder::strategy);