com.mongodb.client.model

Class ReplaceOneModel<T>

java.lang.Object

com.mongodb.client.model.WriteModel<T>

com.mongodb.client.model.ReplaceOneModel<T>

Type Parameters:

T - the type of document to replace. This can be of any type for which a Codec is registered

public final class ReplaceOneModel<T>
extends WriteModel<T>

A model describing the replacement of at most one document that matches the query filter.

Since:

3.0

MongoDB documentation

Replace

Constructor Summary

Constructors

Constructor and Description
ReplaceOneModel(Bson filter, T replacement) Construct a new instance.
ReplaceOneModel(Bson filter, T replacement, UpdateOptions options) Construct a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
Bson	getFilter() Gets the query filter.
UpdateOptions	getOptions() Gets the options to apply.
T	getReplacement() Gets the document which will replace the document matching the query filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReplaceOneModel

public ReplaceOneModel(Bson filter,
               T replacement)

Construct a new instance.

Parameters:

filter - a document describing the query filter, which may not be null.

replacement - the replacement document

ReplaceOneModel

public ReplaceOneModel(Bson filter,
               T replacement,
               UpdateOptions options)

Construct a new instance.

Parameters:

filter - a document describing the query filter, which may not be null.

replacement - the replacement document

options - the options to apply

Method Detail

getFilter

public Bson getFilter()

Gets the query filter.

Returns:

the query filter

getReplacement

public T getReplacement()

Gets the document which will replace the document matching the query filter.

Returns:

the replacement document

getOptions

public UpdateOptions getOptions()

Gets the options to apply.

Returns:

the options