Skip to content

Commit

Permalink
Merge pull request #555 from ajkannan/add-cursor-after-docs
Browse files Browse the repository at this point in the history
Update afterCursor javadoc for v1beta3
  • Loading branch information
ajkannan committed Jan 16, 2016
2 parents 482954f + 3d7ea2c commit 0864393
Showing 1 changed file with 15 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,21 @@ public interface QueryResults<V> extends Iterator<V> {
Class<?> resultClass();

/**
* Returns the Cursor for point after the value returned in the last {@link #next} call.
* Returns the Cursor for the point after the value returned in the last {@link #next} call. This
* cursor can be used to issue subsequent queries (with the same constraints) that may return
* additional results.
*
* <p>A simple use case:
* <pre> {@code
* Query<Entity> query = Query.entityQueryBuilder()
* .kind("Person")
* .filter(PropertyFilter.eq("favoriteFood", "pizza"))
* .build();
* QueryResults<Entity> results = datastore.run(query);
* // Consume some results (using results.next()) and do any other actions as necessary.
* query = query.toBuilder().startCursor(results.cursorAfter()).build();
* results = datastore.run(query); // now we will iterate over all entities not yet consumed
* </pre>
*/
Cursor cursorAfter();
}

0 comments on commit 0864393

Please sign in to comment.