Package com.mongodb.client

Interface MongoIterable<TResult>

Type Parameters:

TResult - The type that this iterable will decode documents to.

All Superinterfaces:

Iterable<TResult>

All Known Subinterfaces:

AggregateIterable<TResult>, ChangeStreamIterable<TResult>, DistinctIterable<TResult>, FindIterable<TResult>, GridFSFindIterable, ListCollectionsIterable<TResult>, ListDatabasesIterable<TResult>, ListIndexesIterable<TResult>, MapReduceIterable<TResult>

public interface MongoIterable<TResult>
extends Iterable<TResult>

The MongoIterable is the results from an operation, such as a query.

Since:

3.0

Method Summary

Modifier and Type	Method	Description
MongoIterable<TResult>	batchSize(int batchSize)	Sets the number of documents to return per batch.
MongoCursor<TResult>	cursor()	Returns a cursor used for iterating over elements of type TResult.
TResult	first()	Helper to return the first item in the iterator or null.
void	forEach(Block<? super TResult> block)	Deprecated. Prefer Iterable.forEach(Consumer), which was added in Java 8
<A extends Collection<? super TResult>> A	into(A target)	Iterates over all the documents, adding each to the given target.
MongoCursor<TResult>	iterator()
<U> MongoIterable<U>	map(Function<TResult,U> mapper)	Maps this iterable from the source document type to the target document type.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

iterator

MongoCursor<TResult> iterator()

Specified by:

iterator in interface Iterable<TResult>

cursor

MongoCursor<TResult> cursor()

Returns a cursor used for iterating over elements of type TResult. The cursor is primarily used for change streams.

Returns:

a cursor

Since:

3.11

first

@Nullable
TResult first()

Helper to return the first item in the iterator or null.

Returns:

T the first item or null.

map

<U> MongoIterable<U> map(Function<TResult,U> mapper)

Maps this iterable from the source document type to the target document type.

Type Parameters:

U - the target document type

Parameters:

mapper - a function that maps from the source to the target document type

Returns:

an iterable which maps T to U

forEach

@Deprecated
void forEach(Block<? super TResult> block)

Deprecated.

Prefer Iterable.forEach(Consumer), which was added in Java 8

Iterates over all documents in the view, applying the given block to each.

Similar to map but the function is fully encapsulated with no returned result.

Parameters:

block - the block to apply to each document of type T.

into

<A extends Collection<? super TResult>> A into(A target)

Iterates over all the documents, adding each to the given target.

Type Parameters:

A - the collection type

Parameters:

target - the collection to insert into

Returns:

the target

batchSize

MongoIterable<TResult> batchSize(int batchSize)

Sets the number of documents to return per batch.

Parameters:

batchSize - the batch size

Returns:

this

MongoDB documentation

Batch Size