T
- the operations result type.public class FindAndReplaceOperation<T> extends BaseFindAndModifyOperation<T>
Modifier and Type | Field and Description |
---|---|
private java.lang.Boolean |
bypassDocumentValidation |
private Collation |
collation |
private Decoder<T> |
decoder |
private BsonDocument |
filter |
private long |
maxTimeMS |
private MongoNamespace |
namespace |
private BsonDocument |
projection |
private BsonDocument |
replacement |
private boolean |
retryWrites |
private boolean |
returnOriginal |
private BsonDocument |
sort |
private boolean |
upsert |
private WriteConcern |
writeConcern |
Constructor and Description |
---|
FindAndReplaceOperation(MongoNamespace namespace,
Decoder<T> decoder,
BsonDocument replacement)
Deprecated.
|
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.
|
Modifier and Type | Method and Description |
---|---|
FindAndReplaceOperation<T> |
bypassDocumentValidation(java.lang.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.
|
java.lang.Boolean |
getBypassDocumentValidation()
Gets the bypass document level validation flag
|
Collation |
getCollation()
Returns the collation options
|
protected CommandOperationHelper.CommandCreator |
getCommandCreator(SessionContext sessionContext) |
protected java.lang.String |
getDatabaseName() |
Decoder<T> |
getDecoder()
Gets the decoder used to decode the result documents.
|
protected FieldNameValidator |
getFieldNameValidator() |
BsonDocument |
getFilter()
Gets the query filter.
|
long |
getMaxTime(java.util.concurrent.TimeUnit timeUnit)
Gets the maximum execution time on the server for this operation.
|
MongoNamespace |
getNamespace()
Gets the namespace.
|
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.
|
WriteConcern |
getWriteConcern()
Get the write concern for this operation
|
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,
java.util.concurrent.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.
|
execute, executeAsync
private final MongoNamespace namespace
private final BsonDocument replacement
private final WriteConcern writeConcern
private final boolean retryWrites
private BsonDocument filter
private BsonDocument projection
private BsonDocument sort
private long maxTimeMS
private boolean returnOriginal
private boolean upsert
private java.lang.Boolean bypassDocumentValidation
private Collation collation
@Deprecated public FindAndReplaceOperation(MongoNamespace namespace, Decoder<T> decoder, BsonDocument replacement)
FindAndReplaceOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument)
insteadnamespace
- the database and collection namespace for the operation.decoder
- the decoder for the result documents.replacement
- the document that will replace the found document.@Deprecated public FindAndReplaceOperation(MongoNamespace namespace, WriteConcern writeConcern, Decoder<T> decoder, BsonDocument replacement)
FindAndReplaceOperation(MongoNamespace, WriteConcern, boolean, Decoder, BsonDocument)
insteadnamespace
- 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.public FindAndReplaceOperation(MongoNamespace namespace, WriteConcern writeConcern, boolean retryWrites, Decoder<T> decoder, BsonDocument replacement)
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.public MongoNamespace getNamespace()
public WriteConcern getWriteConcern()
WriteConcern
public Decoder<T> getDecoder()
getDecoder
in class BaseFindAndModifyOperation<T>
public BsonDocument getReplacement()
public BsonDocument getFilter()
public FindAndReplaceOperation<T> filter(BsonDocument filter)
filter
- the query filter, which may be null.public BsonDocument getProjection()
public FindAndReplaceOperation<T> projection(BsonDocument projection)
projection
- the project document, which may be null.public long getMaxTime(java.util.concurrent.TimeUnit timeUnit)
timeUnit
- the time unit to return the result inpublic FindAndReplaceOperation<T> maxTime(long maxTime, java.util.concurrent.TimeUnit timeUnit)
maxTime
- the max timetimeUnit
- the time unit, which may not be nullpublic BsonDocument getSort()
public FindAndReplaceOperation<T> sort(BsonDocument sort)
sort
- the sort criteria, which may be null.public boolean isReturnOriginal()
public FindAndReplaceOperation<T> returnOriginal(boolean returnOriginal)
returnOriginal
- set to false to return the replaced document rather than the originalpublic boolean isUpsert()
public FindAndReplaceOperation<T> upsert(boolean upsert)
upsert
- true if a new document should be inserted if there are no matches to the query filterpublic java.lang.Boolean getBypassDocumentValidation()
public FindAndReplaceOperation<T> bypassDocumentValidation(java.lang.Boolean bypassDocumentValidation)
Note: This only applies when an $out stage is specified
.bypassDocumentValidation
- If true, allows the write to opt-out of document level validation.public Collation getCollation()
public FindAndReplaceOperation<T> collation(Collation collation)
A null value represents the server default.
collation
- the collation options to useprotected java.lang.String getDatabaseName()
getDatabaseName
in class BaseFindAndModifyOperation<T>
protected CommandOperationHelper.CommandCreator getCommandCreator(SessionContext sessionContext)
getCommandCreator
in class BaseFindAndModifyOperation<T>
protected FieldNameValidator getFieldNameValidator()
getFieldNameValidator
in class BaseFindAndModifyOperation<T>