Package 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	Description
FindOneAndUpdateOptions()

Method Summary

Modifier and Type	Method	Description
FindOneAndUpdateOptions	arrayFilters(List<? extends Bson> arrayFilters)	Sets the array filters option
FindOneAndUpdateOptions	bypassDocumentValidation(Boolean bypassDocumentValidation)	Sets the bypass document level validation flag.
FindOneAndUpdateOptions	collation(Collation collation)	Sets the collation options
List<? extends Bson>	getArrayFilters()	Returns the array filters option
Boolean	getBypassDocumentValidation()	Gets the the bypass document level validation flag
Collation	getCollation()	Returns the collation options
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time for the find one and update operation.
Bson	getProjection()	Gets a document describing the fields to return for all matching documents.
ReturnDocument	getReturnDocument()	Gets the ReturnDocument value indicating whether to return the document before it was updated / inserted or after
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	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
FindOneAndUpdateOptions	projection(Bson projection)	Sets a document describing the fields to return for all matching documents.
FindOneAndUpdateOptions	returnDocument(ReturnDocument returnDocument)	Set whether to return the document before it was updated / inserted or after
FindOneAndUpdateOptions	sort(Bson sort)	Sets the sort criteria to apply to the query.
String	toString()
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, wait, wait, wait

Constructor Detail

FindOneAndUpdateOptions

public FindOneAndUpdateOptions()

Method Detail

getProjection

@Nullable
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(@Nullable
                                          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

@Nullable
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(@Nullable
                                    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

getReturnDocument

public ReturnDocument getReturnDocument()

Gets the ReturnDocument value indicating whether to return the document before it was updated / inserted or after

Returns:

ReturnDocument.BEFORE if returning the document before it was updated or inserted otherwise returns ReturnDocument.AFTER

returnDocument

public FindOneAndUpdateOptions returnDocument(ReturnDocument returnDocument)

Set whether to return the document before it was updated / inserted or after

Parameters:

returnDocument - set whether to return the document before it was updated / inserted or after

Returns:

this

maxTime

public FindOneAndUpdateOptions maxTime(long maxTime,
                                       TimeUnit timeUnit)

Sets the maximum execution time on the server for this operation.

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

getMaxTime

public long getMaxTime(TimeUnit timeUnit)

Gets the maximum execution time for the find one and update operation.

Parameters:

timeUnit - the time unit for the result

Returns:

the max time

getBypassDocumentValidation

@Nullable
public Boolean getBypassDocumentValidation()

Gets the the bypass document level validation flag

Returns:

the bypass document level validation flag

Since:

3.2

Since server release

3.2

bypassDocumentValidation

public FindOneAndUpdateOptions bypassDocumentValidation(@Nullable
                                                        Boolean bypassDocumentValidation)

Sets the bypass document level validation flag.

Parameters:

bypassDocumentValidation - If true, allows the write to opt-out of document level validation.

Returns:

this

Since:

3.2

Since server release

3.2

getCollation

@Nullable
public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since:

3.4

Since server release

3.4

collation

public FindOneAndUpdateOptions collation(@Nullable
                                         Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since:

3.4

Since server release

3.4

arrayFilters

public FindOneAndUpdateOptions arrayFilters(@Nullable
                                            List<? extends Bson> arrayFilters)

Sets the array filters option

Parameters:

arrayFilters - the array filters, which may be null

Returns:

this

Since:

3.6

Since server release

3.6

getArrayFilters

@Nullable
public List<? extends Bson> getArrayFilters()

Returns the array filters option

Returns:

the array filters, which may be null

Since:

3.6

Since server release

3.6

toString

public String toString()

Overrides:

toString in class Object