com.avaje.ebean.QueryIterator Maven / Gradle / Ivy
package com.avaje.ebean;
import java.util.Iterator;
/**
* Used to provide iteration over query results.
*
* This can be used when you want to process a very large number of results and
* means that you don't have to hold all the results in memory at once (unlike
* findList(), findSet() etc where all the beans are held in the List or Set
* etc).
*
*
*
*
* Query<Customer> query = server.find(Customer.class)
* .fetch("contacts", new FetchConfig().query(2))
* .where().gt("id", 0)
* .orderBy("id")
* .setMaxRows(2);
*
* QueryIterator<Customer> it = query.findIterate();
* try {
* while (it.hasNext()) {
* Customer customer = it.next();
* // do something with customer...
* }
* } finally {
* // close the associated resources
* it.close();
* }
*
*
* @author rbygrave
*
* @param
* the type of entity bean in the iteration
*/
public interface QueryIterator extends Iterator, java.io.Closeable {
/**
* Returns true if the iteration has more elements.
*/
boolean hasNext();
/**
* Returns the next element in the iteration.
*/
T next();
/**
* Remove is not allowed.
*/
void remove();
/**
* Close the underlying resources held by this iterator.
*/
void close();
}