org.droitateddb.cursor

Interface ObjectCursor<T>

Type Parameters:

T - Type of the entity.

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, java.lang.Iterable<T>

All Known Subinterfaces:

CombinedCursor<T>

All Known Implementing Classes:

CombinedCursorImpl

public interface ObjectCursor<T>
extends java.lang.Iterable<T>, java.io.Closeable

Cursor for objects of type T which works on the original Cursor.
If the position of the original Cursor is changed, the position of the ObjectCursor is also changed and vice versa.

Resolve the ObjectCursor with an CursorUtil.getObjectCursor(Cursor cursor) from a Cursor resolved with a ContentResolver from a ContentProvider derived by BaseContentProvider.

Author:

Falk Appel, Alexander Frank

Method Summary

Modifier and Type	Method and Description
java.util.Collection<T>	getAll()
T	getCurrent()
T	getFirst()
T	getLast()
T	getNext() Returns the element at the next position of the ObjectCursor.
java.util.Collection<T>	getNext(int amount)
T	getOne()
int	getPosition()
T	getPrevious()
java.util.Collection<T>	getPrevious(int amount)
boolean	hasNext()
boolean	hasPrevious()
boolean	isClosed()
java.util.Iterator<T>	iterator()
boolean	moveToFirst() Move the cursor to the first row.
boolean	moveToLast() Move the cursor to the last row.
boolean	moveToNext() Move the cursor to the next row.
boolean	moveToPosition(int position) Move the cursor to an absolute position.
boolean	moveToPrevious() Move the cursor to the previous row.
int	size()

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.io.Closeable

close

Method Detail

getAll

java.util.Collection<T> getAll()

Returns:

a new mutable Collection containing all elements contained in this ObjectCursor. If the ObjectCursor is empty an empty Collection is returned.

getCurrent

T getCurrent()

Returns:

the element at the current position of the ObjectCursor.
If the Cursor is before the first element, the position is changed to the first position, if the Cursor is after the last element, the position is changed to the last elements position

Throws:

java.util.NoSuchElementException - if there are no elements to be returned.

getFirst

T getFirst()

Returns:

the element at the first position of the ObjectCursor.
The Cursor is moved to the first position.

Throws:

java.util.NoSuchElementException - if there is no element to be returned.

getLast

T getLast()

Returns:

the element at the last position of the ObjectCursor.
The Cursor is moved to the last position.

Throws:

java.util.NoSuchElementException - if there is no element to be returned.

getNext

T getNext()

Returns the element at the next position of the ObjectCursor.
The Cursor is moved to the next position.

Returns:

Element at next position

Throws:

java.util.NoSuchElementException - if there is no element to be returned.

See Also:

hasNext()

getNext

java.util.Collection<T> getNext(int amount)

Parameters:

amount - Number of positions to move forward

Returns:

a new mutable Collection containing the next amount elements contained in this ObjectCursor. If the ObjectCursor contains less than amount elements following the current position a collection with less than amount elements is returned.

Throws:

java.util.NoSuchElementException - if there are no next elements at all

getOne

T getOne()

Returns:

the element at the first position of the ObjectCursor. It is expected, that the Cursor contains exactly one element.

Throws:

java.util.NoSuchElementException - if there is no element to be returned.

java.lang.IllegalStateException - if the Cursor contains more than one element

getPrevious

T getPrevious()

Returns:

the element at the position before the current position of the ObjectCursor.
The Cursor is moved to the previous position.

Throws:

java.util.NoSuchElementException - if there is no element to be returned.

See Also:

hasPrevious()

getPrevious

java.util.Collection<T> getPrevious(int amount)

Parameters:

amount - Number of positions to move backwards

Returns:

a new mutable Collection containing the previous amount elements contained in this ObjectCursor. If the ObjectCursor contains less than amount elements preceding the current position a collection with less than amount elements is returned.

Throws:

java.util.NoSuchElementException - if there are no preceding elements at all

hasNext

boolean hasNext()

Returns:

true if there is at least one more element after the current position, false otherwise.

See Also:

getNext()

hasPrevious

boolean hasPrevious()

Returns:

true if there is at least one more element before the current position, false otherwise.

See Also:

getPrevious()

iterator

java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

Returns:

an Iterator which does not support the Iterator.remove() operation.

See Also:

Iterable.iterator()

size

int size()

Returns:

a count of how many elements this ObjectCursor contains.

isClosed

boolean isClosed()

Returns:

true if this ObjectCursor is closed, otherwise false;

getPosition

int getPosition()

Returns:

the current position of the cursor.

moveToPosition

boolean moveToPosition(int position)

Move the cursor to an absolute position.

Parameters:

position - Position to move to

Returns:

true if the move was succesful.

moveToFirst

boolean moveToFirst()

Move the cursor to the first row.

Returns:

true if the move was succesful.

moveToLast

boolean moveToLast()

Move the cursor to the last row.

Returns:

true if the move was succesful.

moveToNext

boolean moveToNext()

Move the cursor to the next row.

Returns:

true if the move was succesful.

moveToPrevious

boolean moveToPrevious()

Move the cursor to the previous row.

Returns:

true if the move was succesful.