org.apache.ibatis.cursor.defaults

Class DefaultCursor<T>

java.lang.Object

org.apache.ibatis.cursor.defaults.DefaultCursor<T>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>, Cursor<T>

public class DefaultCursor<T>
extends Object
implements Cursor<T>

This is the default implementation of a MyBatis Cursor. This implementation is not thread safe.

Author:

Guillaume Darmont / [email protected]

Constructor Summary

Constructors

Constructor and Description
DefaultCursor(DefaultResultSetHandler resultSetHandler, ResultMap resultMap, ResultSetWrapper rsw, RowBounds rowBounds)

Method Summary

Modifier and Type	Method and Description
void	close()
protected T	fetchNextObjectFromDatabase()
protected T	fetchNextUsingRowBound()
int	getCurrentIndex() Get the current item index.
boolean	isConsumed()
boolean	isOpen()
Iterator<T>	iterator()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

DefaultCursor

public DefaultCursor(DefaultResultSetHandler resultSetHandler,
                     ResultMap resultMap,
                     ResultSetWrapper rsw,
                     RowBounds rowBounds)

Method Detail

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Cursor<T>

Returns:

true if the cursor has started to fetch items from database.

isConsumed

public boolean isConsumed()

Specified by:

isConsumed in interface Cursor<T>

Returns:

true if the cursor is fully consumed and has returned all elements matching the query.

getCurrentIndex

public int getCurrentIndex()

Description copied from interface: Cursor

Get the current item index. The first item has the index 0.

Specified by:

getCurrentIndex in interface Cursor<T>

Returns:

-1 if the first cursor item has not been retrieved. The index of the current item retrieved.

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

fetchNextUsingRowBound

protected T fetchNextUsingRowBound()

fetchNextObjectFromDatabase

protected T fetchNextObjectFromDatabase()