com.mongodb.client.model

Class DeleteOneModel<T>

java.lang.Object

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

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

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

public class DeleteOneModel<T>
extends WriteModel<T>

A model describing the removal of at most one document matching the query filter.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
DeleteOneModel(Bson filter) Construct a new instance.
DeleteOneModel(Bson filter, DeleteOptions options) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
Bson	getFilter() Gets the query filter.
DeleteOptions	getOptions() Gets the options to apply.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteOneModel

public DeleteOneModel(Bson filter)

Construct a new instance.

Parameters:

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

DeleteOneModel

public DeleteOneModel(Bson filter,
                      DeleteOptions options)

Construct a new instance.

Parameters:

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

options - the options to apply

Since:

3.4

Method Detail

getFilter

public Bson getFilter()

Gets the query filter.

Returns:

the query filter

getOptions

public DeleteOptions getOptions()

Gets the options to apply.

Returns:

the options

Since:

3.4

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object