Docs Menu

Docs Home → Develop Applications → Atlas Device SDKs

Class FindOneAndModifyOptions

On this page

  • io.realm.mongodb.mongo.options
  • Constructors
  • Method Summary
  • Inherited Methods
  • Constructor Detail
  • Method Detail
  • getProjection
  • getSort
  • isReturnNewDocument
  • isUpsert
  • projection
  • returnNewDocument
  • sort
  • toString
  • upsert

io.realm.mongodb.mongo.options

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

The options to apply to a findOneAndUpdate, findOneAndReplace, or findOneAndDelete operation (also commonly referred to as findOneAndModify operations).

Constructors

Constructor and Description
FindOneAndModifyOptions ()

Method Summary

Modifier and Type
Method and Description
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 boolean
isReturnNewDocument ()

Returns true if the findOneAndModify operation should return the new document.

public boolean
isUpsert ()

Returns true if a new document should be inserted if there are no matches to the query filter.

public FindOneAndModifyOptions
projection (
Bson projection
)

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

public FindOneAndModifyOptions
returnNewDocument (
boolean returnNewDocument
)

Set to true if findOneAndModify operations should return the new updated document.

public FindOneAndModifyOptions
sort (
Bson sort
)

Sets the sort criteria to apply to the query.

public String
toString ()

public FindOneAndModifyOptions
upsert (
boolean upsert
)

Set to true if a new document should be inserted if there are no matches to the query filter.

Inherited Methods

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

Constructor Detail

public FindOneAndModifyOptions ()

Method Detail

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

isReturnNewDocument

public boolean isReturnNewDocument ()

Returns true if the findOneAndModify operation should return the new document. The default is false Note: Only findOneAndUpdate and findOneAndReplace take this options findOneAndDelete will always return the old document

Returns

true if findOneAndModify operation should return the new document

isUpsert

public boolean isUpsert ()

Returns true if a new document should be inserted if there are no matches to the query filter. The default is false. Note: Only findOneAndUpdate and findOneAndReplace take this option

Returns

true if a new document should be inserted if there are no matches to the query filter

projection

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

returnNewDocument

public FindOneAndModifyOptions returnNewDocument (
boolean returnNewDocument
)

Set to true if findOneAndModify operations should return the new updated document. Set to false / leave blank to have these operation return the document before the update. Note: Only findOneAndUpdate and findOneAndReplace take this options findOneAndDelete will always return the old document

Parameters

  • returnNewDocument - true if findOneAndModify operations should return the updated document

Returns

this

sort

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

upsert

public FindOneAndModifyOptions upsert (
boolean upsert
)

Set to true if a new document should be inserted if there are no matches to the query filter.

Parameters

  • upsert - true if a new document should be inserted if there are no matches to the query filter.

Returns

this

← Class CountOptions
Class FindOptions →

On this page