You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by ok...@apache.org on 2015/10/02 20:51:05 UTC

[2/2] incubator-tinkerpop git commit: merged tp30 Graph JavaDoc.

merged tp30 Graph JavaDoc.


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

Branch: refs/heads/master
Commit: 4d1b92533e6986f879b2c939b50fabeecd6f6cc7
Parents: 3269635 cbf45ca
Author: Marko A. Rodriguez <ok...@gmail.com>
Authored: Fri Oct 2 12:50:56 2015 -0600
Committer: Marko A. Rodriguez <ok...@gmail.com>
Committed: Fri Oct 2 12:50:56 2015 -0600

----------------------------------------------------------------------
 .../tinkerpop/gremlin/structure/Graph.java      | 73 +++++++++++++-------
 1 file changed, 48 insertions(+), 25 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/4d1b9253/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
----------------------------------------------------------------------
diff --cc gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
index 1ff994c,dc70a53..049176b
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
@@@ -141,18 -146,21 +148,33 @@@ public interface Graph extends AutoClos
      public GraphComputer compute() throws IllegalArgumentException;
  
      /**
++<<<<<<< HEAD
 +     * Construct a {@link TraversalSource} using the specified {@code sourceBuilder}.  The {@link TraversalSource}
 +     * provides methods for creating a {@link Traversal} given the context of {@link TraversalStrategy} implementations
 +     * and a {@link GraphComputer}.
++=======
+      * Generate a {@link TraversalSource} given a {@link TraversalSource.Builder} for this {@link Graph}.
+      *
+      * @param sourceBuilder The traversal source builder to use
+      * @param <C>           The traversal source class
+      * @return a traversal source for this graph given the traversal source builder
++>>>>>>> tp30
       */
      public default <C extends TraversalSource> C traversal(final TraversalSource.Builder<C> sourceBuilder) {
          return sourceBuilder.create(this);
      }
  
      /**
++<<<<<<< HEAD
 +     * Construct a {@link GraphTraversalSource} instance using the {@link StandardTraversalEngine}. The
 +     * {@link TraversalSource} provides methods for creating a {@link Traversal} given the context of
 +     * {@link TraversalStrategy} implementations and a {@link GraphComputer}.
++=======
+      * Generate a {@link GraphTraversalSource} using the {@link StandardTraversalEngine} (i.e. classic Gremlin with OLTP).
+      * This is a short hand method for the more involved method that uses {@link Graph#traversal(TraversalSource.Builder)}.
+      *
+      * @return A standard graph traversal source
++>>>>>>> tp30
       */
      public default GraphTraversalSource traversal() {
          return this.traversal(GraphTraversalSource.build().engine(StandardTraversalEngine.build()));
@@@ -185,9 -193,9 +207,9 @@@
       * If the graph return {@code true} for {@link Features.VertexFeatures#supportsAnyIds()} ()} then it should support
       * filters as with:
       * <ul>
-      *     <li>g.vertices(v.id())</li>
+      * <li>g.vertices(v.id())</li>
       * </ul>
 -     * <p/>
 +     * <p/>                                                                                                         
       * If the graph return {@code true} for {@link Features.VertexFeatures#supportsStringIds()} ()} then it should support
       * filters as with:
       * <ul>
@@@ -1195,7 -1203,7 +1217,8 @@@
           * default, an empty array is assigned and it is thus assumed that all computers are excluded when an
           * {@code OptOut} annotation is used, therefore this value must be overridden to be more specific.
           */
 -        public Class<? extends GraphComputer>[] computers() default {};
 +        public String[] computers() default { };
++
      }
  
      /**