tinkerpop-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From spmalle...@apache.org
Subject [08/20] tinkerpop git commit: Added some javadoc CTR
Date Thu, 09 Aug 2018 11:28:27 GMT
Added some javadoc CTR


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

Branch: refs/heads/TINKERPOP-1976
Commit: ce947388e505436d97bcfb55de45d0a52bf8b075
Parents: 7fce137
Author: Stephen Mallette <spmva@genoprime.com>
Authored: Sat Aug 4 06:27:46 2018 -0400
Committer: Stephen Mallette <spmva@genoprime.com>
Committed: Sat Aug 4 06:27:46 2018 -0400

----------------------------------------------------------------------
 .../apache/tinkerpop/gremlin/driver/Client.java  | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/ce947388/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
----------------------------------------------------------------------
diff --git a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
index 3da8663..efbc844 100644
--- a/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
+++ b/gremlin-driver/src/main/java/org/apache/tinkerpop/gremlin/driver/Client.java
@@ -23,6 +23,7 @@ import org.apache.tinkerpop.gremlin.driver.message.RequestMessage;
 import org.apache.tinkerpop.gremlin.process.traversal.Bytecode;
 import org.apache.tinkerpop.gremlin.process.traversal.Traversal;
 import org.apache.tinkerpop.gremlin.process.traversal.TraversalSource;
+import org.apache.tinkerpop.gremlin.process.traversal.Traverser;
 import org.apache.tinkerpop.gremlin.structure.Graph;
 import org.apache.tinkerpop.gremlin.util.iterator.IteratorUtils;
 import org.slf4j.Logger;
@@ -131,7 +132,10 @@ public abstract class Client {
     }
 
     /**
-     * Submit a {@link Traversal} to the server for remote execution.
+     * Submit a {@link Traversal} to the server for remote execution.Results are returned
as {@link Traverser}
+     * instances and are therefore bulked, meaning that to properly iterate the contents
of the result each
+     * {@link Traverser#bulk()} must be examined to determine the number of times that object
should be presented in
+     * iteration.
      */
     public ResultSet submit(final Traversal traversal) {
         try {
@@ -144,14 +148,19 @@ public abstract class Client {
     }
 
     /**
-     * An asynchronous version of {@link #submit(Traversal)}.
+     * An asynchronous version of {@link #submit(Traversal)}. Results are returned as {@link
Traverser} instances and
+     * are therefore bulked, meaning that to properly iterate the contents of the result
each {@link Traverser#bulk()}
+     * must be examined to determine the number of times that object should be presented
in iteration.
      */
     public CompletableFuture<ResultSet> submitAsync(final Traversal traversal) {
         throw new UnsupportedOperationException("This implementation does not support Traversal
submission - use a sessionless Client created with from the alias() method");
     }
 
     /**
-     * Submit a {@link Bytecode} to the server for remote execution.
+     * Submit a {@link Bytecode} to the server for remote execution. Results are returned
as {@link Traverser}
+     * instances and are therefore bulked, meaning that to properly iterate the contents
of the result each
+     * {@link Traverser#bulk()} must be examined to determine the number of times that object
should be presented in
+     * iteration.
      */
     public ResultSet submit(final Bytecode bytecode) {
         try {
@@ -164,7 +173,9 @@ public abstract class Client {
     }
 
     /**
-     * An asynchronous version of {@link #submit(Traversal)}.
+     * An asynchronous version of {@link #submit(Traversal)}. Results are returned as {@link
Traverser} instances and
+     * are therefore bulked, meaning that to properly iterate the contents of the result
each {@link Traverser#bulk()}
+     * must be examined to determine the number of times that object should be presented
in iteration.
      */
     public CompletableFuture<ResultSet> submitAsync(final Bytecode bytecode) {
         throw new UnsupportedOperationException("This implementation does not support Traversal
submission - use a sessionless Client created with from the alias() method");


Mime
View raw message