io.realm.mongodb.mongo.iterable

Class FindIterable<ResultT>

java.lang.Object

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

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

Type Parameters:

ResultT - The type to which this iterable will decode documents.

public class FindIterable<ResultT>
extends MongoIterable<ResultT>

Specific iterable for MongoCollection.find() operations.

Constructor Summary

Constructors

Constructor and Description
FindIterable(OsMongoCollection osMongoCollection, CodecRegistry codecRegistry, Class<ResultT> resultClass, TaskDispatcher dispatcher)

Method Summary

Modifier and Type	Method and Description
FindIterable<ResultT>	filter(Bson filter) Sets the query filter to apply to the query.
FindIterable<ResultT>	limit(int limit) Sets the limit to apply.
FindIterable<ResultT>	projection(Bson projection) Sets a document describing the fields to return for all matching documents.
FindIterable<ResultT>	sort(Bson sort) Sets the sort criteria to apply to the query.

Methods inherited from class io.realm.mongodb.mongo.iterable.MongoIterable

first, iterator

Methods inherited from class java.lang.Object

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

Constructor Detail

FindIterable

public FindIterable(OsMongoCollection osMongoCollection,
                    CodecRegistry codecRegistry,
                    Class<ResultT> resultClass,
                    TaskDispatcher dispatcher)

Method Detail

filter

public FindIterable<ResultT> filter(Bson filter)

Sets the query filter to apply to the query.

Parameters:

filter - the filter, which may be null.

Returns:

this

limit

public FindIterable<ResultT> limit(int limit)

Sets the limit to apply.

Parameters:

limit - the limit, which may be 0

Returns:

this

projection

public FindIterable<ResultT> projection(Bson projection)

Sets a document describing the fields to return for all matching documents.

Parameters:

projection - the project document, which may be null.

Returns:

this

sort

public FindIterable<ResultT> sort(Bson sort)

Sets the sort criteria to apply to the query.

Parameters:

sort - the sort criteria, which may be null.

Returns:

this