com.j256.ormlite.dao

Interface CloseableIterator<T>

All Superinterfaces:

AutoCloseable, Iterator<T>

All Known Implementing Classes:

SelectIterator

public interface CloseableIterator<T>
extends Iterator<T>, AutoCloseable

Extension to Iterator to provide a close() method. This should be in the JDK.

NOTE: You must call AutoCloseable.close() method when you are done otherwise the underlying SQL statement and connection may be kept open.

Author:

graywatson

Method Summary

Modifier and Type	Method and Description
void	closeQuietly() Close any underlying SQL statements but swallow any SQLExceptions.
T	current() Return the current result object that we have accessed or null if none.
T	first() Move to the first result and return it or null if none.
DatabaseResults	getRawResults() Return the underlying database results object if any.
T	moveAbsolute(int position) Move to an absolute position in the list and return that result or null if none.
T	moveRelative(int offset) Move a relative position in the list and return that result or null if none.
void	moveToNext() Move to the next item in the iterator without calling Iterator.next().
T	nextThrow() Returns the Iterator.next() object in the table or null if none.
T	previous() Moves to the previous result and return it or null if none.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

closeQuietly

void closeQuietly()

Close any underlying SQL statements but swallow any SQLExceptions.

getRawResults

DatabaseResults getRawResults()

Return the underlying database results object if any. May return null. This should not be used unless you know what you are doing. For example, if you shift the cursor in the raw-results, this could cause problems when you come back here to go the next result.

moveToNext

void moveToNext()

Move to the next item in the iterator without calling Iterator.next().

first

T first()
 throws SQLException

Move to the first result and return it or null if none. This may not work with the default iterator depending on your database.

Throws:

SQLException

previous

T previous()
    throws SQLException

Moves to the previous result and return it or null if none. This may not work with the default iterator depending on your database.

Throws:

SQLException

current

T current()
   throws SQLException

Return the current result object that we have accessed or null if none.

Throws:

SQLException

nextThrow

T nextThrow()
     throws SQLException

Returns the Iterator.next() object in the table or null if none.

Throws:

SQLException - Throws a SQLException on error since Iterator.next() cannot throw because it is part of the Iterator definition. It will not throw if there is no next.

moveRelative

T moveRelative(int offset)
        throws SQLException

Move a relative position in the list and return that result or null if none. Moves forward (positive value) or backwards (negative value) the list of results. moveRelative(1) should be the same as Iterator.next(). moveRelative(-1) is the same as previous() result. This may not work with the default iterator depending on your database.

Parameters:

offset - Number of rows to move. Positive moves forward in the results. Negative moves backwards.

Returns:

The object at the new position or null of none.

Throws:

SQLException

moveAbsolute

T moveAbsolute(int position)
        throws SQLException

Move to an absolute position in the list and return that result or null if none. This may not be supported depending on your database or depending on the type of iterator and where you are moving. For example, in JDBC-land, often the iterator created can only move forward and will throw an exception if you attempt to move to an absolute position behind the current position.

Parameters:

position - Row number in the result list to move to.

Returns:

The object at the new position or null of none.

Throws:

SQLException