ResultIterator (cayenne-doc: Cayenne Documentation 4.2 API)

All Superinterfaces:

AutoCloseable, Iterable<T>

All Known Implementing Classes:

ConnectionAwareResultIterator, DistinctResultIterator, JDBCResultIterator, LimitResultIterator
```
public interface ResultIterator<T>
extends Iterable<T>, AutoCloseable
```
Defines API of an iterator over the records returned as a result of Select queries execution. Usually a ResultIterator is supported by an open java.sql.ResultSet, therefore ResultIterators must be explicitly closed when the user is done working with them. An alternative to that is ObjectContext.iterate(org.apache.cayenne.query.Select, ResultIteratorCallback) method that handles resource management.

Since:

3.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`List<T>`	`allRows()`	Returns all yet unread rows from ResultSet without closing it.
`void`	`close()`	Closes ResultIterator and associated ResultSet.
`boolean`	`hasNextRow()`	Returns true if there is at least one more record that can be read from the iterator.
`T`	`nextRow()`	Returns the next result row that is, depending on the query, may be a scalar value, a DataRow, or an Object[] array containing a mix of scalars and DataRows.
`void`	`skipRow()`	Goes past current row.

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
  - allRows
```
List<T> allRows()
```
    Returns all yet unread rows from ResultSet without closing it.
    
    Since:
    
    3.0
  - hasNextRow
```
boolean hasNextRow()
```
    Returns true if there is at least one more record that can be read from the iterator.
  - nextRow
```
T nextRow()
```
    Returns the next result row that is, depending on the query, may be a scalar value, a DataRow, or an Object[] array containing a mix of scalars and DataRows.
    
    Since:
    
    3.0
  - skipRow
```
void skipRow()
```
    Goes past current row. If the row is not needed, this may save some time on data conversion.
    
    Since:
    
    3.0
  - close
```
void close()
```
    Closes ResultIterator and associated ResultSet. This method must be called explicitly when the user is finished processing the records. Otherwise unused database resources will not be released properly.
    
    Specified by:
    
    close in interface AutoCloseable