io.realm.mongodb.mongo.options

Class FindOptions

java.lang.Object

io.realm.mongodb.mongo.options.FindOptions

public class FindOptions
extends Object

The options to apply to a find operation (also commonly referred to as a query).

Constructor Summary

Constructors

Constructor and Description
FindOptions() Construct a new instance.

Method Summary

Modifier and Type	Method and Description
int	getLimit() Gets the limit to apply.
Bson	getProjection() Gets a document describing the fields to return for all matching documents.
Bson	getSort() Gets the sort criteria to apply to the query.
FindOptions	limit(int limit) Sets the limit to apply.
FindOptions	projection(Bson projection) Sets a document describing the fields to return for all matching documents.
FindOptions	sort(Bson sort) Sets the sort criteria to apply to the query.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FindOptions

public FindOptions()

Construct a new instance.

Method Detail

getLimit

public int getLimit()

Gets the limit to apply. The default is null.

Returns:

the limit

limit

public FindOptions limit(int limit)

Sets the limit to apply.

Parameters:

limit - the limit, which may be null

Returns:

this

getProjection

public Bson getProjection()

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

Returns:

the project document, which may be null

projection

public FindOptions 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

getSort

public Bson getSort()

Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order.

Returns:

a document describing the sort criteria

sort

public FindOptions sort(Bson sort)

Sets the sort criteria to apply to the query.

Parameters:

sort - the sort criteria, which may be null.

Returns:

this

toString

public String toString()

Overrides:

toString in class Object