/*
* Copyright (c) 2008-2015 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.client.model;
import org.bson.conversions.Bson;
import java.util.concurrent.TimeUnit;
import static com.mongodb.assertions.Assertions.notNull;
import static java.util.concurrent.TimeUnit.MILLISECONDS;
/**
* The options to apply to an operation that atomically finds a document and updates it.
*
* @since 3.0
* @mongodb.driver.manual reference/command/findAndModify/
*/
public class FindOneAndUpdateOptions {
private Bson projection;
private Bson sort;
private boolean upsert;
private ReturnDocument returnDocument = ReturnDocument.BEFORE;
private long maxTimeMS;
private Boolean bypassDocumentValidation;
private Collation collation;
/**
* Gets a document describing the fields to return for all matching documents.
*
* @return the project document, which may be null
* @mongodb.driver.manual tutorial/project-fields-from-query-results Projection
*/
public Bson 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 tutorial/project-fields-from-query-results Projection
*/
public FindOneAndUpdateOptions projection(final Bson projection) {
this.projection = projection;
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 Bson 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 FindOneAndUpdateOptions sort(final Bson sort) {
this.sort = sort;
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 FindOneAndUpdateOptions upsert(final boolean upsert) {
this.upsert = upsert;
return this;
}
/**
* Gets the {@link ReturnDocument} value indicating whether to return the document before it was updated / inserted or after
*
* @return {@link ReturnDocument#BEFORE} if returning the document before it was updated or inserted otherwise
* returns {@link ReturnDocument#AFTER}
*/
public ReturnDocument getReturnDocument() {
return returnDocument;
}
/**
* Set whether to return the document before it was updated / inserted or after
*
* @param returnDocument set whether to return the document before it was updated / inserted or after
* @return this
*/
public FindOneAndUpdateOptions returnDocument(final ReturnDocument returnDocument) {
this.returnDocument = returnDocument;
return this;
}
/**
* 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 FindOneAndUpdateOptions maxTime(final long maxTime, final TimeUnit timeUnit) {
notNull("timeUnit", timeUnit);
this.maxTimeMS = MILLISECONDS.convert(maxTime, timeUnit);
return this;
}
/**
* Gets the maximum execution time for the find one and update operation.
*
* @param timeUnit the time unit for the result
* @return the max time
*/
public long getMaxTime(final TimeUnit timeUnit) {
return timeUnit.convert(maxTimeMS, MILLISECONDS);
}
/**
* Gets the the bypass document level validation flag
*
* @return the bypass document level validation flag
* @since 3.2
* @mongodb.server.release 3.2
*/
public Boolean getBypassDocumentValidation() {
return bypassDocumentValidation;
}
/**
* Sets the bypass document level validation flag.
*
* @param bypassDocumentValidation If true, allows the write to opt-out of document level validation.
* @return this
* @since 3.2
* @mongodb.server.release 3.2
*/
public FindOneAndUpdateOptions bypassDocumentValidation(final Boolean bypassDocumentValidation) {
this.bypassDocumentValidation = bypassDocumentValidation;
return this;
}
/**
* Returns the collation options
*
* @return the collation options
* @since 3.4
* @mongodb.server.release 3.4
*/
public Collation getCollation() {
return collation;
}
/**
* Sets the collation options
*
* <p>A null value represents the server default.</p>
* @param collation the collation options to use
* @return this
* @since 3.4
* @mongodb.server.release 3.4
*/
public FindOneAndUpdateOptions collation(final Collation collation) {
this.collation = collation;
return this;
}
}