com.mongodb.client.model

Class FindOneAndUpdateOptions

java.lang.Object

com.mongodb.client.model.FindOneAndUpdateOptions

public class FindOneAndUpdateOptions
extends Object

The options to apply to an operation that atomically finds a document and updates it.

Since:

3.0

MongoDB documentation

reference/command/findAndModify/

Constructor Summary

Constructors

Constructor and Description
FindOneAndUpdateOptions()

Method Summary

Methods

Modifier and Type	Method and Description
Bson	getProjection() Gets a document describing the fields to return for all matching documents.
boolean	getReturnOriginal() When true, return the original document from before it was updated.
Bson	getSort() Gets the sort criteria to apply to the query.
boolean	isUpsert() Returns true if a new document should be inserted if there are no matches to the query filter.
FindOneAndUpdateOptions	projection(Bson projection) Sets a document describing the fields to return for all matching documents.
FindOneAndUpdateOptions	returnOriginal(boolean returnOriginal) Set whether to return the original document from before it was updated.
FindOneAndUpdateOptions	sort(Bson sort) Sets the sort criteria to apply to the query.
FindOneAndUpdateOptions	upsert(boolean upsert) Set to true if a new document should be inserted if there are no matches to the query filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

FindOneAndUpdateOptions

public FindOneAndUpdateOptions()

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

MongoDB documentation

Projection

projection

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

MongoDB documentation

Projection

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

MongoDB documentation

Sort

sort

public FindOneAndUpdateOptions sort(Bson sort)

Sets the sort criteria to apply to the query.

Parameters:

sort - the sort criteria, which may be null.

Returns:

this

MongoDB documentation

Sort

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.

Returns:

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

upsert

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

getReturnOriginal

public boolean getReturnOriginal()

When true, return the original document from before it was updated. The default is true.

Returns:

true if the original document should be returned

returnOriginal

public FindOneAndUpdateOptions returnOriginal(boolean returnOriginal)

Set whether to return the original document from before it was updated.

Parameters:

returnOriginal - set whether to return the original document from before it was updated

Returns:

this