Package com.mongodb.client.model

Class FindOneAndDeleteOptions

java.lang.Object

com.mongodb.client.model.FindOneAndDeleteOptions

public class FindOneAndDeleteOptions
extends Object

The options to apply to an operation that atomically finds a document and deletes it.

Since:

3.0

MongoDB documentation

reference/command/findAndModify/

Constructor Summary

Constructors

Constructor	Description
FindOneAndDeleteOptions()

Method Summary

Modifier and Type	Method	Description
FindOneAndDeleteOptions	collation(Collation collation)	Sets the collation options
Collation	getCollation()	Returns the collation options
Bson	getHint()	Gets the hint to apply.
String	getHintString()	Gets the hint string to apply.
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time for the find one and delete operation.
Bson	getProjection()	Gets a document describing the fields to return for all matching documents.
Bson	getSort()	Gets the sort criteria to apply to the query.
FindOneAndDeleteOptions	hint(Bson hint)	Sets the hint to apply.
FindOneAndDeleteOptions	hintString(String hint)	Sets the hint to apply.
FindOneAndDeleteOptions	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
FindOneAndDeleteOptions	projection(Bson projection)	Sets a document describing the fields to return for all matching documents.
FindOneAndDeleteOptions	sort(Bson sort)	Sets the sort criteria to apply to the query.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FindOneAndDeleteOptions

public FindOneAndDeleteOptions()

Method Detail

getProjection

@Nullable
public Bson getProjection()

Gets a document describing the fields to return for all matching documents.

Returns:

the project document, which may be null

MongoDB documentation

Projection

projection

public FindOneAndDeleteOptions projection(@Nullable
                                          Bson projection)

Sets a document describing the fields to return for all matching documents.

Parameters:

projection - the project document, which may be null.

Returns:

this

MongoDB documentation

Projection

getSort

@Nullable
public Bson getSort()

Gets the sort criteria to apply to the query. The default is null, which means that the documents will be returned in an undefined order.

Returns:

a document describing the sort criteria

MongoDB documentation

Sort

sort

public FindOneAndDeleteOptions sort(@Nullable
                                    Bson sort)

Sets the sort criteria to apply to the query.

Parameters:

sort - the sort criteria, which may be null.

Returns:

this

MongoDB documentation

Sort

maxTime

public FindOneAndDeleteOptions maxTime(long maxTime,
                                       TimeUnit timeUnit)

Sets the maximum execution time on the server for this operation.

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

getMaxTime

public long getMaxTime(TimeUnit timeUnit)

Gets the maximum execution time for the find one and delete operation.

Parameters:

timeUnit - the time unit for the result

Returns:

the max time

getCollation

@Nullable
public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since:

3.4

Since server release

3.4

collation

public FindOneAndDeleteOptions 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:

3.4

Since server release

3.4

getHint

@Nullable
public Bson getHint()

Gets the hint to apply.

Returns:

the hint, which should describe an existing index

Since:

4.1

Since server release

4.4

getHintString

@Nullable
public String getHintString()

Gets the hint string to apply.

Returns:

the hint string, which should be the name of an existing index

Since:

4.1

Since server release

4.4

hint

public FindOneAndDeleteOptions hint(@Nullable
                                    Bson hint)

Sets the hint to apply.

Parameters:

hint - a document describing the index which should be used for this operation.

Returns:

this

Since:

4.1

Since server release

4.4

hintString

public FindOneAndDeleteOptions hintString(@Nullable
                                          String hint)

Sets the hint to apply.

Note: If hint(Bson) is set that will be used instead of any hint string.

Parameters:

hint - the name of the index which should be used for the operation

Returns:

this

Since:

4.1

Since server release

4.4

toString

public String toString()

Overrides:

toString in class Object