Docs Menu

Docs Home → Develop Applications → Atlas Device SDKs

Class FindOptions

On this page

  • io.realm.mongodb.mongo.options
  • Constructors
  • Method Summary
  • Inherited Methods
  • Constructor Detail
  • Method Detail
  • getLimit
  • getProjection
  • getSort
  • limit
  • projection
  • sort
  • toString

io.realm.mongodb.mongo.options

java.lang.Object
io.realm.mongodb.mongo.options.FindOptions

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

Constructors

Constructor and Description
FindOptions ()

Construct a new instance.

Method Summary

Modifier and Type
Method and Description
public int
getLimit ()

Gets the limit to apply.

public Bson
getProjection ()

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

public Bson
getSort ()

Gets the sort criteria to apply to the query.

public FindOptions
limit (
int limit
)

Sets the limit to apply.

public FindOptions
projection (
Bson projection
)

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

public FindOptions
sort (
Bson sort
)

Sets the sort criteria to apply to the query.

public String
toString ()

Inherited Methods

  • Methods inherited from class java.lang.Object : getClass , hashCode , equals , clone , toString , notify , notifyAll , wait , wait , wait , finalize

Constructor Detail

public FindOptions ()

Construct a new instance.

Method Detail

getLimit

public int getLimit ()

Gets the limit to apply. The default is null.

Returns

the limit

getProjection

public Bson getProjection ()

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

Returns

the project document, which may be null

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

limit

public FindOptions limit (
int limit
)

Sets the limit to apply.

Parameters

  • limit - the limit, which may be null

Returns

this

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

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

← Class FindOneAndModifyOptions
Class InsertManyResult →

On this page