Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update afterCursor javadoc for v1beta3 #555

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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();
}