Module is.codion.framework.db

Package is.codion.framework.db

Interface EntityResultIterator

All Superinterfaces:

AutoCloseable, Iterable<Entity>, Iterator<Entity>

public interface EntityResultIterator
extends Iterator<Entity>, Iterable<Entity>, AutoCloseable

Iterates through an Entity based query result. Use try with resources or remember to call close() in order to close underlying resources.

 try (EntityResultIterator iterator = connection.iterator(select)) {
   while (iterator.hasNext()) {
     Entity entity = iterator.next();
     // process entity
   }
 }

Method Summary

Modifier and Type	Method	Description
void	close()
default Iterator<Entity>	iterator()	Returns this iterator, enabling use in a for-each loop.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Method Details

close

void close()

Specified by:

close in interface AutoCloseable

iterator

default Iterator<Entity> iterator()

Returns this iterator, enabling use in a for-each loop. Note that this iterator is single-use; a new iterator must be obtained in order to iterate the results again.

Specified by:

iterator in interface Iterable<Entity>

Returns:

this iterator