io.realm.mongodb.mongo.iterable

Class MongoCursor<ResultT>

java.lang.Object

io.realm.mongodb.mongo.iterable.MongoCursor<ResultT>

Type Parameters:

ResultT - The type of documents the cursor contains

All Implemented Interfaces:

Closeable, AutoCloseable, Iterator<ResultT>

public class MongoCursor<ResultT>
extends Object
implements Iterator<ResultT>, Closeable

The Mongo Cursor class is fundamentally an Iterator containing an additional tryNext() method for convenience.

An application should ensure that a cursor is closed in all circumstances, e.g. using a try-with-resources statement.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	hasNext()
ResultT	next()
ResultT	tryNext() A special next() case that returns the next document if available or null.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<ResultT>

next

public ResultT next()

Specified by:

next in interface Iterator<ResultT>

tryNext

public ResultT tryNext()

A special next() case that returns the next document if available or null.

Returns:

A Task containing the next document if available or null.

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable