Package 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	Description
ReplaceOneModel(Bson filter, T replacement)	Construct a new instance.
ReplaceOneModel(Bson filter, T replacement, ReplaceOptions options)	Construct a new instance.
ReplaceOneModel(Bson filter, T replacement, UpdateOptions options)	Deprecated. use ReplaceOneModel(Bson, Object, ReplaceOptions) instead

Method Summary

Modifier and Type	Method	Description
Bson	getFilter()	Gets the query filter.
UpdateOptions	getOptions()	Deprecated. use getReplaceOptions() instead
T	getReplacement()	Gets the document which will replace the document matching the query filter.
ReplaceOptions	getReplaceOptions()	Gets the ReplaceOptions to apply.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

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

Deprecated. use ReplaceOneModel(Bson, Object, ReplaceOptions) instead

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

ReplaceOneModel

public ReplaceOneModel(Bson filter,
                       T replacement,
                       ReplaceOptions 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

Since:

3.7

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

@Deprecated
public UpdateOptions getOptions()

Deprecated. use getReplaceOptions() instead

Gets the options to apply.

Returns:

the update options

getReplaceOptions

public ReplaceOptions getReplaceOptions()

Gets the ReplaceOptions to apply.

Returns:

the replace options

Since:

3.7

toString

public String toString()

Overrides:

toString in class Object