/*
 * Copyright 2008-present 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 com.mongodb.lang.Nullable;
import org.bson.conversions.Bson;

import java.util.List;

import static com.mongodb.assertions.Assertions.notNull;

A model describing an update to all documents that matches the query filter. The update to apply must include only update operators.
Type parameters:
  • <T> – the type of document to update. In practice this doesn't actually apply to updates but is here for consistency with the other write models
Since:3.0
@mongodb.driver.manualtutorial/modify-documents/ Updates
@mongodb.driver.manualreference/operator/update/ Update Operators
/** * A model describing an update to all documents that matches the query filter. The update to apply must include only update * operators. * * @param <T> the type of document to update. In practice this doesn't actually apply to updates but is here for consistency with the * other write models * @since 3.0 * @mongodb.driver.manual tutorial/modify-documents/ Updates * @mongodb.driver.manual reference/operator/update/ Update Operators */
public final class UpdateManyModel<T> extends WriteModel<T> { private final Bson filter; private final Bson update; private final List<? extends Bson> updatePipeline; private final UpdateOptions options;
Construct a new instance.
Params:
  • filter – a document describing the query filter, which may not be null.
  • update – a document describing the update, which may not be null. The update to apply must include only update operators.
/** * Construct a new instance. * * @param filter a document describing the query filter, which may not be null. * @param update a document describing the update, which may not be null. The update to apply must include only update * operators. */
public UpdateManyModel(final Bson filter, final Bson update) { this(filter, update, new UpdateOptions()); }
Construct a new instance.
Params:
  • filter – a document describing the query filter, which may not be null.
  • update – a document describing the update, which may not be null. The update to apply must include only update operators.
  • options – the options to apply
/** * Construct a new instance. * * @param filter a document describing the query filter, which may not be null. * @param update a document describing the update, which may not be null. The update to apply must include only update * operators. * @param options the options to apply */
public UpdateManyModel(final Bson filter, final Bson update, final UpdateOptions options) { this.filter = notNull("filter", filter); this.update = notNull("update", update); this.updatePipeline = null; this.options = notNull("options", options); }
Construct a new instance.
Params:
  • filter – a document describing the query filter, which may not be null.
  • update – a pipeline describing the update, which may not be null.
Since:3.11
@mongodb.server.release4.2
/** * Construct a new instance. * * @param filter a document describing the query filter, which may not be null. * @param update a pipeline describing the update, which may not be null. * @since 3.11 * @mongodb.server.release 4.2 */
public UpdateManyModel(final Bson filter, final List<? extends Bson> update) { this(filter, update, new UpdateOptions()); }
Construct a new instance.
Params:
  • filter – a document describing the query filter, which may not be null.
  • update – a pipeline describing the update, which may not be null.
  • options – the options to apply
Since:3.11
@mongodb.server.release4.2
/** * Construct a new instance. * * @param filter a document describing the query filter, which may not be null. * @param update a pipeline describing the update, which may not be null. * @param options the options to apply * @since 3.11 * @mongodb.server.release 4.2 */
public UpdateManyModel(final Bson filter, final List<? extends Bson> update, final UpdateOptions options) { this.filter = notNull("filter", filter); this.update = null; this.updatePipeline = update; this.options = notNull("options", options); }
Gets the query filter.
Returns:the query filter
/** * Gets the query filter. * * @return the query filter */
public Bson getFilter() { return filter; }
Gets the document specifying the updates to apply to the matching document. The update to apply must include only update operators.
Returns:the document specifying the updates to apply
/** * Gets the document specifying the updates to apply to the matching document. The update to apply must include only update * operators. * * @return the document specifying the updates to apply */
@Nullable public Bson getUpdate() { return update; }
Gets the pipeline specifying the updates to apply to the matching document. The update to apply must include only update operators.
Returns:the pipeline specifying the updates to apply
Since:3.11
@mongodb.server.release4.2
/** * Gets the pipeline specifying the updates to apply to the matching document. The update to apply must include only update * operators. * * @return the pipeline specifying the updates to apply * @since 3.11 * @mongodb.server.release 4.2 */
@Nullable public List<? extends Bson> getUpdatePipeline() { return updatePipeline; }
Gets the options to apply.
Returns:the options
/** * Gets the options to apply. * * @return the options */
public UpdateOptions getOptions() { return options; } @Override public String toString() { return "UpdateManyModel{" + "filter=" + filter + ", update=" + (update != null ? update : updatePipeline) + ", options=" + options + '}'; } }