com.mongodb.operation.FindAndReplaceOperation Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongo-java-driver Show documentation
Show all versions of mongo-java-driver Show documentation
The MongoDB Java Driver uber-artifact, containing mongodb-driver, mongodb-driver-core, and bson
The newest version!
/*
* Copyright (c) 2008-2014 MongoDB, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mongodb.operation;
import com.mongodb.MongoNamespace;
import com.mongodb.async.SingleResultCallback;
import com.mongodb.binding.AsyncWriteBinding;
import com.mongodb.binding.WriteBinding;
import com.mongodb.internal.validator.CollectibleDocumentFieldNameValidator;
import com.mongodb.internal.validator.MappedFieldNameValidator;
import com.mongodb.internal.validator.NoOpFieldNameValidator;
import org.bson.BsonDocument;
import org.bson.BsonString;
import org.bson.FieldNameValidator;
import org.bson.codecs.Decoder;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import static com.mongodb.assertions.Assertions.notNull;
import static com.mongodb.operation.CommandOperationHelper.executeWrappedCommandProtocol;
import static com.mongodb.operation.CommandOperationHelper.executeWrappedCommandProtocolAsync;
import static com.mongodb.operation.DocumentHelper.putIfNotNull;
import static com.mongodb.operation.DocumentHelper.putIfNotZero;
import static com.mongodb.operation.DocumentHelper.putIfTrue;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
/**
* An operation that atomically finds and replaces a single document.
*
* @param the operations result type.
* @since 3.0
*/
public class FindAndReplaceOperation implements AsyncWriteOperation, WriteOperation {
private final MongoNamespace namespace;
private final Decoder decoder;
private final BsonDocument replacement;
private BsonDocument filter;
private BsonDocument projection;
private BsonDocument sort;
private long maxTimeMS;
private boolean returnOriginal = true;
private boolean upsert;
/**
* Construct a new instance.
*
* @param namespace the database and collection namespace for the operation.
* @param decoder the decoder for the result documents.
* @param replacement the document that will replace the found document.
*/
public FindAndReplaceOperation(final MongoNamespace namespace, final Decoder decoder, final BsonDocument replacement) {
this.namespace = notNull("namespace", namespace);
this.decoder = notNull("decoder", decoder);
this.replacement = notNull("replacement", replacement);
}
/**
* Gets the namespace.
*
* @return the namespace
*/
public MongoNamespace getNamespace() {
return namespace;
}
/**
* Gets the decoder used to decode the result documents.
*
* @return the decoder
*/
public Decoder getDecoder() {
return decoder;
}
/**
* Gets the document which will replace the document matching the query filter.
*
* @return the replacement document
*/
public BsonDocument getReplacement() {
return replacement;
}
/**
* Gets the query filter.
*
* @return the query filter
* @mongodb.driver.manual reference/method/db.collection.find/ Filter
*/
public BsonDocument getFilter() {
return filter;
}
/**
* Sets the query filter to apply to the query.
*
* @param filter the query filter, which may be null.
* @return this
* @mongodb.driver.manual reference/method/db.collection.find/ Filter
*/
public FindAndReplaceOperation filter(final BsonDocument filter) {
this.filter = filter;
return this;
}
/**
* Gets a document describing the fields to return for all matching documents.
*
* @return the project document, which may be null
* @mongodb.driver.manual reference/method/db.collection.find/ Projection
*/
public BsonDocument getProjection() {
return projection;
}
/**
* Sets a document describing the fields to return for all matching documents.
*
* @param projection the project document, which may be null.
* @return this
* @mongodb.driver.manual reference/method/db.collection.find/ Projection
*/
public FindAndReplaceOperation projection(final BsonDocument projection) {
this.projection = projection;
return this;
}
/**
* Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.
*
* @param timeUnit the time unit to return the result in
* @return the maximum execution time in the given time unit
*/
public long getMaxTime(final TimeUnit timeUnit) {
notNull("timeUnit", timeUnit);
return timeUnit.convert(maxTimeMS, TimeUnit.MILLISECONDS);
}
/**
* Sets the maximum execution time on the server for this operation.
*
* @param maxTime the max time
* @param timeUnit the time unit, which may not be null
* @return this
*/
public FindAndReplaceOperation maxTime(final long maxTime, final TimeUnit timeUnit) {
notNull("timeUnit", timeUnit);
this.maxTimeMS = TimeUnit.MILLISECONDS.convert(maxTime, timeUnit);
return this;
}
/**
* 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.
*
* @return a document describing the sort criteria
* @mongodb.driver.manual reference/method/cursor.sort/ Sort
*/
public BsonDocument getSort() {
return sort;
}
/**
* Sets the sort criteria to apply to the query.
*
* @param sort the sort criteria, which may be null.
* @return this
* @mongodb.driver.manual reference/method/cursor.sort/ Sort
*/
public FindAndReplaceOperation sort(final BsonDocument sort) {
this.sort = sort;
return this;
}
/**
* When false, returns the replaced document rather than the original. The default is false.
*
* @return true if the original document should be returned
*/
public boolean isReturnOriginal() {
return returnOriginal;
}
/**
* Set to false to return the replaced document rather than the original.
*
* @param returnOriginal set to false to return the replaced document rather than the original
* @return this
*/
public FindAndReplaceOperation returnOriginal(final boolean returnOriginal) {
this.returnOriginal = returnOriginal;
return this;
}
/**
* Returns true if a new document should be inserted if there are no matches to the query filter. The default is false.
*
* @return true if a new document should be inserted if there are no matches to the query filter
*/
public boolean isUpsert() {
return upsert;
}
/**
* Set to true if a new document should be inserted if there are no matches to the query filter.
*
* @param upsert true if a new document should be inserted if there are no matches to the query filter
* @return this
*/
public FindAndReplaceOperation upsert(final boolean upsert) {
this.upsert = upsert;
return this;
}
@Override
public T execute(final WriteBinding binding) {
return executeWrappedCommandProtocol(binding, namespace.getDatabaseName(), getCommand(), getValidator(),
CommandResultDocumentCodec.create(decoder, "value"),
FindAndModifyHelper.transformer());
}
@Override
public void executeAsync(final AsyncWriteBinding binding, final SingleResultCallback callback) {
executeWrappedCommandProtocolAsync(binding, namespace.getDatabaseName(), getCommand(), getValidator(),
CommandResultDocumentCodec.create(decoder, "value"),
FindAndModifyHelper.transformer(), callback);
}
private BsonDocument getCommand() {
BsonDocument command = new BsonDocument("findandmodify", new BsonString(namespace.getCollectionName()));
putIfNotNull(command, "query", getFilter());
putIfNotNull(command, "fields", getProjection());
putIfNotNull(command, "sort", getSort());
putIfTrue(command, "new", !isReturnOriginal());
putIfTrue(command, "upsert", isUpsert());
putIfNotZero(command, "maxTimeMS", getMaxTime(MILLISECONDS));
command.put("update", getReplacement());
return command;
}
private FieldNameValidator getValidator() {
Map map = new HashMap();
map.put("update", new CollectibleDocumentFieldNameValidator());
return new MappedFieldNameValidator(new NoOpFieldNameValidator(), map);
}
}