Package com.mongodb.client.model

Class DeleteOptions

java.lang.Object

com.mongodb.client.model.DeleteOptions

public class DeleteOptions
extends Object

The options to apply when deleting documents.

Since:

3.4

MongoDB documentation

Remove documents

Delete Command

Constructor Summary

Constructors

Constructor	Description
DeleteOptions()

Method Summary

Modifier and Type	Method	Description
DeleteOptions	collation(Collation collation)	Sets the collation options
Collation	getCollation()	Returns the collation options
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteOptions

public DeleteOptions()

Method Detail

getCollation

@Nullable
public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since server release

3.4

collation

public DeleteOptions collation(@Nullable
                               Collation collation)

Sets the collation options

A null value represents the server default.

Parameters:

collation - the collation options to use

Returns:

this

Since server release

3.4

toString

public String toString()

Overrides:

toString in class Object