Package com.mongodb.client.model

Class FindOneAndReplaceOptions

java.lang.Object

com.mongodb.client.model.FindOneAndReplaceOptions

public class FindOneAndReplaceOptions
extends Object

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

Since:

3.0

MongoDB documentation

reference/command/findAndModify/

Constructor Summary

Constructors

Constructor	Description
FindOneAndReplaceOptions()

Method Summary

Modifier and Type	Method	Description
FindOneAndReplaceOptions	bypassDocumentValidation(Boolean bypassDocumentValidation)	Sets the bypass document level validation flag.
FindOneAndReplaceOptions	collation(Collation collation)	Sets the collation options
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 replace 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 replaced 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.
FindOneAndReplaceOptions	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
FindOneAndReplaceOptions	projection(Bson projection)	Sets a document describing the fields to return for all matching documents.
FindOneAndReplaceOptions	returnDocument(ReturnDocument returnDocument)	Set whether to return the document before it was replaced or after
FindOneAndReplaceOptions	sort(Bson sort)	Sets the sort criteria to apply to the query.
String	toString()
FindOneAndReplaceOptions	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

FindOneAndReplaceOptions

public FindOneAndReplaceOptions()

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 FindOneAndReplaceOptions 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 FindOneAndReplaceOptions 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 FindOneAndReplaceOptions 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 replaced or after

Returns:

ReturnDocument.BEFORE if returning the document before it was replaced otherwise return ReturnDocument.AFTER

returnDocument

public FindOneAndReplaceOptions returnDocument(ReturnDocument returnDocument)

Set whether to return the document before it was replaced or after

Parameters:

returnDocument - set whether to return the document before it was replaced or after

Returns:

this

maxTime

public FindOneAndReplaceOptions 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 replace 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 FindOneAndReplaceOptions 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 FindOneAndReplaceOptions 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

toString

public String toString()

Overrides:

toString in class Object