tinkerpop-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From spmalle...@apache.org
Subject tinkerpop git commit: Added javadoc for skip() CTR
Date Tue, 21 Feb 2017 14:50:03 GMT
Repository: tinkerpop
Updated Branches:
  refs/heads/master 5f54d1126 -> d9659cd8a


Added javadoc for skip() CTR


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

Branch: refs/heads/master
Commit: d9659cd8aa81db54bce9f872a662912ba614e52d
Parents: 5f54d11
Author: Stephen Mallette <spmva@genoprime.com>
Authored: Tue Feb 21 09:49:32 2017 -0500
Committer: Stephen Mallette <spmva@genoprime.com>
Committed: Tue Feb 21 09:49:32 2017 -0500

----------------------------------------------------------------------
 .../process/traversal/dsl/graph/GraphTraversal.java  | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/d9659cd8/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
index 7d0432d..c8786ab 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.java
@@ -1685,11 +1685,26 @@ public interface GraphTraversal<S, E> extends Traversal<S,
E> {
                 : new TailLocalStep<>(this.asAdmin(), limit));
     }
 
+    /**
+     * Filters out the first {@code n} objects in the traversal.
+     *
+     * @param skip the number of objects to skip
+     * @return the traversal with an appended {@link RangeGlobalStep}
+     * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#skip-step"
target="_blank">Reference Documentation - Skip Step</a>
+     */
     public default GraphTraversal<S, E> skip(final long skip) {
         this.asAdmin().getBytecode().addStep(Symbols.skip, skip);
         return this.asAdmin().addStep(new RangeGlobalStep<>(this.asAdmin(), skip, -1));
     }
 
+    /**
+     * Filters out the first {@code n} objects in the traversal.
+     *
+     * @param scope the scope of how to apply the {@code tail}
+     * @param skip the number of objects to skip
+     * @return the traversal with an appended {@link RangeGlobalStep} or {@link RangeLocalStep}
depending on {@code scope}
+     * @see <a href="http://tinkerpop.apache.org/docs/${project.version}/reference/#skip-step"
target="_blank">Reference Documentation - Skip Step</a>
+     */
     public default <E2> GraphTraversal<S, E2> skip(final Scope scope, final long
skip) {
         this.asAdmin().getBytecode().addStep(Symbols.skip, scope, skip);
         return this.asAdmin().addStep(scope.equals(Scope.global)


Mime
View raw message