java/src/main/com/google/appengine/api/datastore/QueryResultIterator.java

   1 // Copyright 2009 Google Inc. All Rights Reserved.
   2 package com.google.appengine.api.datastore;
   3
   4 import java.util.Iterator;
   5 import java.util.List;
   6
   7 /**
   8  * A class that iterates through the results of a {@link Query}
   9  *
  10  * @param <T> the type of result returned by the query
  11  *
  12  */
  13 public interface QueryResultIterator<T> extends Iterator<T> {
  14   /**
  15    * Get the indexes used to perform the query.
  16    *
  17    * @return A list of index references, with no duplicates, or {@code null} if
  18    * the indexes are not known.
  19    */
  20   List<Index> getIndexList();
  21
  22   /**
  23    * Gets a {@link Cursor} that points to the {@link Entity} immediately after
  24    * the last {@link Entity} that was retrieved by {@link #next()}.
  25    *
  26    * @return a {@link Cursor} or {@code null} if this query result cannot be resumed. (Note that
  27    *     a Cursor is returned even if the last element has been reached).
  28    */
  29   Cursor getCursor();
  30 }