com.mongodb.operation

Class ListCollectionsOperation.ProjectingBatchCursor

java.lang.Object

com.mongodb.operation.ListCollectionsOperation.ProjectingBatchCursor

All Implemented Interfaces:

BatchCursor<T>, java.io.Closeable, java.lang.AutoCloseable, java.util.Iterator<java.util.List<T>>

Enclosing class:

ListCollectionsOperation<T>

private final class ListCollectionsOperation.ProjectingBatchCursor
extends java.lang.Object
implements BatchCursor<T>

Field Summary

Fields

Modifier and Type	Field and Description
private BatchCursor<BsonDocument>	delegate

Constructor Summary

Constructors

Modifier	Constructor and Description
private	ProjectingBatchCursor(BatchCursor<BsonDocument> delegate)

Method Summary

Modifier and Type	Method and Description
void	close()
int	getBatchSize() Gets the batch size to use when requesting the next batch.
ServerAddress	getServerAddress() Returns the server address
ServerCursor	getServerCursor() Returns the server cursor
boolean	hasNext() Returns true if another batch of results exists.
java.util.List<T>	next() Returns the next batch of results.
void	remove()
void	setBatchSize(int batchSize) Sets the batch size to use when requesting the next batch.
java.util.List<T>	tryNext() A special next() case that returns the next batch 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

delegate

private final BatchCursor<BsonDocument> delegate

Constructor Detail

ProjectingBatchCursor

private ProjectingBatchCursor(BatchCursor<BsonDocument> delegate)

Method Detail

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<java.util.List<T>>

close

public void close()

Specified by:

close in interface BatchCursor<T>

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

hasNext

public boolean hasNext()

Description copied from interface: BatchCursor

Returns true if another batch of results exists. A tailable cursor will block until another batch exists.

Specified by:

hasNext in interface BatchCursor<T>

Specified by:

hasNext in interface java.util.Iterator<java.util.List<T>>

Returns:

true if another batch exists

next

public java.util.List<T> next()

Description copied from interface: BatchCursor

Returns the next batch of results. A tailable cursor will block until another batch exists.

Specified by:

next in interface BatchCursor<T>

Specified by:

next in interface java.util.Iterator<java.util.List<T>>

Returns:

the next batch of results

setBatchSize

public void setBatchSize(int batchSize)

Description copied from interface: BatchCursor

Sets the batch size to use when requesting the next batch. This is the number of documents to request in the next batch.

Specified by:

setBatchSize in interface BatchCursor<T>

Parameters:

batchSize - the non-negative batch size. 0 means to use the server default.

getBatchSize

public int getBatchSize()

Description copied from interface: BatchCursor

Gets the batch size to use when requesting the next batch. This is the number of documents to request in the next batch.

Specified by:

getBatchSize in interface BatchCursor<T>

Returns:

the non-negative batch size. 0 means to use the server default.

tryNext

public java.util.List<T> tryNext()

Description copied from interface: BatchCursor

A special next() case that returns the next batch 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 batch if a document had been added to the capped collection.

Specified by:

tryNext in interface BatchCursor<T>

Returns:

the next batch if available or null.

getServerCursor

public ServerCursor getServerCursor()

Description copied from interface: BatchCursor

Returns the server cursor

Specified by:

getServerCursor in interface BatchCursor<T>

Returns:

ServerCursor

getServerAddress

public ServerAddress getServerAddress()

Description copied from interface: BatchCursor

Returns the server address

Specified by:

getServerAddress in interface BatchCursor<T>

Returns:

ServerAddress