com.mongodb

Class MongoMappingCursor<T,U>

java.lang.Object

com.mongodb.MongoMappingCursor<T,U>

All Implemented Interfaces:

MongoCursor<U>, java.io.Closeable, java.lang.AutoCloseable, java.util.Iterator<U>

class MongoMappingCursor<T,U>
extends java.lang.Object
implements MongoCursor<U>

Field Summary

Fields

Modifier and Type	Field and Description
private Function<T,U>	mapper
private MongoCursor<T>	proxied

Constructor Summary

Constructors

Constructor and Description
MongoMappingCursor(MongoCursor<T> proxied, Function<T,U> mapper)

Method Summary

Modifier and Type	Method and Description
void	close()
ServerAddress	getServerAddress() Returns the server address
ServerCursor	getServerCursor() Returns the server cursor, which can be null if the no cursor was created or if the cursor has been exhausted or killed.
boolean	hasNext()
U	next()
void	remove()
U	tryNext() A special next() case that returns the next element in the iteration if available or null.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

proxied

private final MongoCursor<T> proxied

mapper

private final Function<T,U> mapper

Constructor Detail

MongoMappingCursor

public MongoMappingCursor(MongoCursor<T> proxied,
                          Function<T,U> mapper)

Method Detail

close

public void close()

Specified by:

close in interface MongoCursor<U>

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

hasNext

public boolean hasNext()

Specified by:

hasNext in interface MongoCursor<U>

Specified by:

hasNext in interface java.util.Iterator<U>

next

public U next()

Specified by:

next in interface MongoCursor<U>

Specified by:

next in interface java.util.Iterator<U>

tryNext

public U tryNext()

Description copied from interface: MongoCursor

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.

Specified by:

tryNext in interface MongoCursor<U>

Returns:

the next element in the iteration if available or null.

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<U>

getServerCursor

public ServerCursor getServerCursor()

Description copied from interface: MongoCursor

Returns the server cursor, which can be null if the no cursor was created or if the cursor has been exhausted or killed.

Specified by:

getServerCursor in interface MongoCursor<U>

Returns:

the ServerCursor, which can be null.

getServerAddress

public ServerAddress getServerAddress()

Description copied from interface: MongoCursor

Returns the server address

Specified by:

getServerAddress in interface MongoCursor<U>

Returns:

ServerAddress