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>
Deprecated.
@Deprecated 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)
Deprecated.Construct a new instance.FindAndReplaceOperation(MongoNamespace namespace, WriteConcern writeConcern, Decoder<T> decoder, BsonDocument replacement)
Deprecated.FindAndReplaceOperation(MongoNamespace namespace, Decoder<T> decoder, BsonDocument replacement)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FindAndReplaceOperation<T>
bypassDocumentValidation(Boolean bypassDocumentValidation)
Deprecated.Sets the bypass document level validation flag.FindAndReplaceOperation<T>
collation(Collation collation)
Deprecated.Sets the collation optionsFindAndReplaceOperation<T>
filter(BsonDocument filter)
Deprecated.Sets the query filter to apply to the query.Boolean
getBypassDocumentValidation()
Deprecated.Gets the bypass document level validation flagCollation
getCollation()
Deprecated.Returns the collation optionsprotected com.mongodb.operation.CommandOperationHelper.CommandCreator
getCommandCreator(SessionContext sessionContext)
Deprecated.protected String
getDatabaseName()
Deprecated.protected FieldNameValidator
getFieldNameValidator()
Deprecated.BsonDocument
getFilter()
Deprecated.Gets the query filter.long
getMaxTime(TimeUnit timeUnit)
Deprecated.Gets the maximum execution time on the server for this operation.BsonDocument
getProjection()
Deprecated.Gets a document describing the fields to return for all matching documents.BsonDocument
getReplacement()
Deprecated.Gets the document which will replace the document matching the query filter.BsonDocument
getSort()
Deprecated.Gets the sort criteria to apply to the query.boolean
isReturnOriginal()
Deprecated.When false, returns the replaced document rather than the original.boolean
isUpsert()
Deprecated.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)
Deprecated.Sets the maximum execution time on the server for this operation.FindAndReplaceOperation<T>
projection(BsonDocument projection)
Deprecated.Sets a document describing the fields to return for all matching documents.FindAndReplaceOperation<T>
returnOriginal(boolean returnOriginal)
Deprecated.Set to false to return the replaced document rather than the original.FindAndReplaceOperation<T>
sort(BsonDocument sort)
Deprecated.Sets the sort criteria to apply to the query.FindAndReplaceOperation<T>
upsert(boolean upsert)
Deprecated.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
-
-
-
-
Constructor Detail
-
FindAndReplaceOperation
@Deprecated public FindAndReplaceOperation(MongoNamespace namespace, Decoder<T> decoder, BsonDocument replacement)
Deprecated. useFindAndReplaceOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument)
insteadConstruct 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. useFindAndReplaceOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument)
insteadConstruct a new instance.- Parameters:
namespace
- the database and collection namespace for the operation.writeConcern
- the writeConcern for the operationdecoder
- 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)
Deprecated.Construct a new instance.- Parameters:
namespace
- the database and collection namespace for the operation.writeConcern
- the writeConcern for the operationretryWrites
- 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()
Deprecated.Gets the document which will replace the document matching the query filter.- Returns:
- the replacement document
-
getFilter
public BsonDocument getFilter()
Deprecated.Gets the query filter.- Returns:
- the query filter
- MongoDB documentation
- Filter
-
filter
public FindAndReplaceOperation<T> filter(BsonDocument filter)
Deprecated.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()
Deprecated.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)
Deprecated.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)
Deprecated.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)
Deprecated.Sets the maximum execution time on the server for this operation.- Parameters:
maxTime
- the max timetimeUnit
- the time unit, which may not be null- Returns:
- this
-
getSort
public BsonDocument getSort()
Deprecated.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)
Deprecated.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()
Deprecated.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)
Deprecated.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()
Deprecated.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)
Deprecated.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()
Deprecated.Gets the bypass document level validation flag- Returns:
- the bypass document level validation flag
- Since:
- 3.2
-
bypassDocumentValidation
public FindAndReplaceOperation<T> bypassDocumentValidation(Boolean bypassDocumentValidation)
Deprecated.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()
Deprecated.Returns the collation options- Returns:
- the collation options
- Since:
- 3.4
- Since server release
- 3.4
-
collation
public FindAndReplaceOperation<T> collation(Collation collation)
Deprecated.Sets the collation optionsA 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()
Deprecated.- Specified by:
getDatabaseName
in classBaseFindAndModifyOperation<T>
-
getCommandCreator
protected com.mongodb.operation.CommandOperationHelper.CommandCreator getCommandCreator(SessionContext sessionContext)
Deprecated.- Specified by:
getCommandCreator
in classBaseFindAndModifyOperation<T>
-
getFieldNameValidator
protected FieldNameValidator getFieldNameValidator()
Deprecated.- Specified by:
getFieldNameValidator
in classBaseFindAndModifyOperation<T>
-
-