com.mongodb.client

Interface MongoCursor<TResult>

Type Parameters:

TResult - The type of documents the cursor contains

All Superinterfaces:

AutoCloseable, Closeable, Iterator<TResult>

@NotThreadSafe
public interface MongoCursor<TResult>
extends Iterator<TResult>, Closeable

The Mongo Cursor interface implementing the iterator protocol

Since:

3.0

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
ServerAddress	getServerAddress() Returns the server address
ServerCursor	getServerCursor() Returns the server cursor
boolean	hasNext()
TResult	next()
TResult	tryNext() A special next() case that returns the next element in the iteration if available or null.

Methods inherited from interface java.util.Iterator

remove

Method Detail

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

hasNext

boolean hasNext()

Specified by:

hasNext in interface Iterator<TResult>

next

TResult next()

Specified by:

next in interface Iterator<TResult>

tryNext

TResult tryNext()

A special next() case that returns the next element in the iteration if available or null.

Tailable cursors are an example where this is useful. A call to tryNext() may return null, but in the future calling tryNext() would return a new element if a document had been added to the capped collection.

Returns:

the next element in the iteration if available or null.

MongoDB documentation

Tailable Cursor

getServerCursor

ServerCursor getServerCursor()

Returns the server cursor

Returns:

ServerCursor

getServerAddress

ServerAddress getServerAddress()

Returns the server address

Returns:

ServerAddress