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 2016/03/01 01:00:06 UTC
incubator-tinkerpop git commit: more JavaDoc.
Repository: incubator-tinkerpop
Updated Branches:
refs/heads/TINKERPOP-1166 2d19b37c8 -> d1f6d3aa0
more 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/d1f6d3aa
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/d1f6d3aa
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/d1f6d3aa
Branch: refs/heads/TINKERPOP-1166
Commit: d1f6d3aa06484831e6797885a876ca83f5f36580
Parents: 2d19b37
Author: Marko A. Rodriguez <ok...@gmail.com>
Authored: Mon Feb 29 17:00:02 2016 -0700
Committer: Marko A. Rodriguez <ok...@gmail.com>
Committed: Mon Feb 29 17:00:02 2016 -0700
----------------------------------------------------------------------
.../apache/tinkerpop/gremlin/process/traversal/step/Barrier.java | 1 +
.../tinkerpop/gremlin/process/traversal/step/ByModulating.java | 4 ++++
.../tinkerpop/gremlin/process/traversal/step/GraphComputing.java | 2 +-
.../gremlin/process/traversal/step/TimesModulating.java | 2 ++
4 files changed, 8 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/d1f6d3aa/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Barrier.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Barrier.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Barrier.java
index 416bc54..1289f64 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Barrier.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/Barrier.java
@@ -25,6 +25,7 @@ import java.util.NoSuchElementException;
* A Barrier is any step that requires all left traversers to be processed prior to emitting result traversers to the right.
* Note that some barrier steps may be "lazy" in that if their algorithm permits, they can emit right traversers prior to all traversers being aggregated.
* A barrier is the means by which a distributed step in {@link org.apache.tinkerpop.gremlin.process.computer.traversal.TraversalVertexProgram} is synchronized and made to behave a single step.
+ * All Barrier steps implement {@link MemoryComputing} as that is how barriers communicate with one another in {@link org.apache.tinkerpop.gremlin.process.computer.GraphComputer}.
*
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/d1f6d3aa/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/ByModulating.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/ByModulating.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/ByModulating.java
index f1eccd9..bea1b56 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/ByModulating.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/ByModulating.java
@@ -34,6 +34,10 @@ import java.util.Comparator;
import java.util.function.Function;
/**
+ * A {@code ByModulating} step is able to take {@link org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal#by} calls.
+ * All the methods have default implementations excecpt {@link ByModulating#modulateBy(Traversal.Admin)}.
+ * In short, given a traversal, what should the ByModulating step do with it.
+ *
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
public interface ByModulating {
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/d1f6d3aa/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/GraphComputing.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/GraphComputing.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/GraphComputing.java
index 8690048..0028eb1 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/GraphComputing.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/GraphComputing.java
@@ -25,7 +25,7 @@ package org.apache.tinkerpop.gremlin.process.traversal.step;
*
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
-public interface GraphComputing<R> {
+public interface GraphComputing {
/**
* The step will be executing on a {@link org.apache.tinkerpop.gremlin.process.computer.GraphComputer}.
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/d1f6d3aa/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/TimesModulating.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/TimesModulating.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/TimesModulating.java
index 9bf71a0..3e8f32f 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/TimesModulating.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/step/TimesModulating.java
@@ -20,6 +20,8 @@
package org.apache.tinkerpop.gremlin.process.traversal.step;
/**
+ * A {@code TimesModulating} step is one that can do something with {@link org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal#times(int)}.
+ *
* @author Marko A. Rodriguez (http://markorodriguez.com)
*/
public interface TimesModulating {