Package com.mongodb.operation

Class FindAndReplaceOperation<T>

java.lang.Object

com.mongodb.operation.BaseFindAndModifyOperation<T>

com.mongodb.operation.FindAndReplaceOperation<T>

Type Parameters:

T - the operations result type.

All Implemented Interfaces:

AsyncWriteOperation<T>, WriteOperation<T>

public class FindAndReplaceOperation<T>
extends BaseFindAndModifyOperation<T>

An operation that atomically finds and replaces a single document.

Since:

3.0

MongoDB documentation

findAndModify

Constructor Summary

Constructors

Constructor	Description
FindAndReplaceOperation(MongoNamespace namespace, WriteConcern writeConcern, boolean retryWrites, Decoder<T> decoder, BsonDocument replacement)	Construct a new instance.
FindAndReplaceOperation(MongoNamespace namespace, WriteConcern writeConcern, Decoder<T> decoder, BsonDocument replacement)	Deprecated. use FindAndReplaceOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument) instead
FindAndReplaceOperation(MongoNamespace namespace, Decoder<T> decoder, BsonDocument replacement)	Deprecated. use FindAndReplaceOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument) instead

Method Summary

Modifier and Type	Method	Description
FindAndReplaceOperation<T>	bypassDocumentValidation(Boolean bypassDocumentValidation)	Sets the bypass document level validation flag.
FindAndReplaceOperation<T>	collation(Collation collation)	Sets the collation options
FindAndReplaceOperation<T>	filter(BsonDocument filter)	Sets the query filter to apply to the query.
Boolean	getBypassDocumentValidation()	Gets the bypass document level validation flag
Collation	getCollation()	Returns the collation options
protected com.mongodb.operation.CommandOperationHelper.CommandCreator	getCommandCreator(SessionContext sessionContext)
protected String	getDatabaseName()
protected FieldNameValidator	getFieldNameValidator()
BsonDocument	getFilter()	Gets the query filter.
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time on the server for this operation.
BsonDocument	getProjection()	Gets a document describing the fields to return for all matching documents.
BsonDocument	getReplacement()	Gets the document which will replace the document matching the query filter.
BsonDocument	getSort()	Gets the sort criteria to apply to the query.
boolean	isReturnOriginal()	When false, returns the replaced document rather than the original.
boolean	isUpsert()	Returns true if a new document should be inserted if there are no matches to the query filter.
FindAndReplaceOperation<T>	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
FindAndReplaceOperation<T>	projection(BsonDocument projection)	Sets a document describing the fields to return for all matching documents.
FindAndReplaceOperation<T>	returnOriginal(boolean returnOriginal)	Set to false to return the replaced document rather than the original.
FindAndReplaceOperation<T>	sort(BsonDocument sort)	Sets the sort criteria to apply to the query.
FindAndReplaceOperation<T>	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 com.mongodb.operation.BaseFindAndModifyOperation

addTxnNumberToCommand, addWriteConcernToCommand, execute, executeAsync, getDecoder, getNamespace, getWriteConcern, isRetryWrites

Methods inherited from class java.lang.Object

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

Constructor Detail

FindAndReplaceOperation

@Deprecated
public FindAndReplaceOperation(MongoNamespace namespace,
                               Decoder<T> decoder,
                               BsonDocument replacement)

Deprecated. use FindAndReplaceOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument) instead

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

decoder - the decoder for the result documents.

replacement - the document that will replace the found document.

FindAndReplaceOperation

@Deprecated
public FindAndReplaceOperation(MongoNamespace namespace,
                               WriteConcern writeConcern,
                               Decoder<T> decoder,
                               BsonDocument replacement)

Deprecated. use FindAndReplaceOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument) instead

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

writeConcern - the writeConcern for the operation

decoder - the decoder for the result documents.

replacement - the document that will replace the found document.

Since:

3.2

FindAndReplaceOperation

public FindAndReplaceOperation(MongoNamespace namespace,
                               WriteConcern writeConcern,
                               boolean retryWrites,
                               Decoder<T> decoder,
                               BsonDocument replacement)

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

writeConcern - the writeConcern for the operation

retryWrites - if writes should be retried if they fail due to a network error.

decoder - the decoder for the result documents.

replacement - the document that will replace the found document.

Since:

3.6

Method Detail

getReplacement

public BsonDocument getReplacement()

Gets the document which will replace the document matching the query filter.

Returns:

the replacement document

getFilter

public BsonDocument getFilter()

Gets the query filter.

Returns:

the query filter

MongoDB documentation

Filter

filter

public FindAndReplaceOperation<T> filter(BsonDocument filter)

Sets the query filter to apply to the query.

Parameters:

filter - the query filter, which may be null.

Returns:

this

MongoDB documentation

Filter

getProjection

public BsonDocument 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 FindAndReplaceOperation<T> projection(BsonDocument 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

getMaxTime

public long getMaxTime(TimeUnit timeUnit)

Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.

Parameters:

timeUnit - the time unit to return the result in

Returns:

the maximum execution time in the given time unit

maxTime

public FindAndReplaceOperation<T> 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

getSort

public BsonDocument 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 FindAndReplaceOperation<T> sort(BsonDocument sort)

Sets the sort criteria to apply to the query.

Parameters:

sort - the sort criteria, which may be null.

Returns:

this

MongoDB documentation

Sort

isReturnOriginal

public boolean isReturnOriginal()

When false, returns the replaced document rather than the original. The default is false.

Returns:

true if the original document should be returned

returnOriginal

public FindAndReplaceOperation<T> returnOriginal(boolean returnOriginal)

Set to false to return the replaced document rather than the original.

Parameters:

returnOriginal - set to false to return the replaced document rather than the original

Returns:

this

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 FindAndReplaceOperation<T> 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

getBypassDocumentValidation

public Boolean getBypassDocumentValidation()

Gets the bypass document level validation flag

Returns:

the bypass document level validation flag

Since:

3.2

bypassDocumentValidation

public FindAndReplaceOperation<T> bypassDocumentValidation(Boolean bypassDocumentValidation)

Sets the bypass document level validation flag.

Note: This only applies when an $out stage is specified

.

Parameters:

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

Returns:

this

Since:

3.2

MongoDB documentation

Aggregation

Since server release

3.2

getCollation

public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since:

3.4

Since server release

3.4

collation

public FindAndReplaceOperation<T> collation(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

getDatabaseName

protected String getDatabaseName()

Specified by:

getDatabaseName in class BaseFindAndModifyOperation<T>

getCommandCreator

protected com.mongodb.operation.CommandOperationHelper.CommandCreator getCommandCreator(SessionContext sessionContext)

Specified by:

getCommandCreator in class BaseFindAndModifyOperation<T>

getFieldNameValidator

protected FieldNameValidator getFieldNameValidator()

Specified by:

getFieldNameValidator in class BaseFindAndModifyOperation<T>