com.googlecode.mjorm

Class ObjectIterator<E>

java.lang.Object

com.googlecode.mjorm.ObjectIterator<E>

Type Parameters:

E -

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Iterator<E>

public class ObjectIterator<E>
extends java.lang.Object
implements java.lang.Iterable<E>, java.util.Iterator<E>

An ObjectIterator provides mapping features for DBCursorss. Basically it returns java objects rather than DBObjects.

Constructor Summary

Constructors

Constructor and Description
ObjectIterator(com.mongodb.DBCursor cursor, ObjectMapper objectMapper, java.lang.Class<E> clazz) Creates the ObjectIterator.

Method Summary

Methods

Modifier and Type	Method and Description
E	current()
com.mongodb.DBCursor	getDBCursor() Returns the underlying DBCursor.
boolean	hasNext()
java.util.Iterator<E>	iterator() For for loops.
E	next()
java.util.List<E>	readAll() Reads all of the objects behind this cursor and returns them in a List.
java.util.List<E>	readAll(java.util.List<E> ret) Reads all of the objects behind this cursor and returns them in a List.
void	remove() DBCursor.remove().

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectIterator

public ObjectIterator(com.mongodb.DBCursor cursor,
              ObjectMapper objectMapper,
              java.lang.Class<E> clazz)

Creates the ObjectIterator.

Parameters:

cursor - the cursor to wrap

objectMapper - the ObjectMapper to use

clazz - the class we're returning

Method Detail

iterator

public java.util.Iterator<E> iterator()

For for loops.

Specified by:

iterator in interface java.lang.Iterable<E>

readAll

public java.util.List<E> readAll(java.util.List<E> ret)

Reads all of the objects behind this cursor and returns them in a List.

Parameters:

ret - the list to read the objects into

Returns:

the List of objects.

readAll

public java.util.List<E> readAll()

Reads all of the objects behind this cursor and returns them in a List.

Returns:

the List of objects.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<E>

next

public E next()

Specified by:

next in interface java.util.Iterator<E>

current

public E current()

remove

public void remove()

DBCursor.remove().

Specified by:

remove in interface java.util.Iterator<E>

getDBCursor

public com.mongodb.DBCursor getDBCursor()

Returns the underlying DBCursor.

Returns:

the DBCursor