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 aCodec
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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Bson
getFilter()
Gets the query filter.T
getReplacement()
Gets the document which will replace the document matching the query filter.ReplaceOptions
getReplaceOptions()
Gets the ReplaceOptions to apply.String
toString()
-
-
-
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, ReplaceOptions options)
Construct a new instance.- Parameters:
filter
- a document describing the query filter, which may not be null.replacement
- the replacement documentoptions
- 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
-
getReplaceOptions
public ReplaceOptions getReplaceOptions()
Gets the ReplaceOptions to apply.- Returns:
- the replace options
- Since:
- 3.7
-
-