Package com.mongodb.operation

Class FindAndDeleteOperation<T>

java.lang.Object

com.mongodb.operation.BaseFindAndModifyOperation<T>

com.mongodb.operation.FindAndDeleteOperation<T>

Type Parameters:

T - the operations result type.

All Implemented Interfaces:

AsyncWriteOperation<T>, WriteOperation<T>

public class FindAndDeleteOperation<T>
extends BaseFindAndModifyOperation<T>

An operation that atomically finds and deletes a single document.

Since:

3.0

MongoDB documentation

findAndModify

Constructor Summary

Constructors

Constructor	Description
FindAndDeleteOperation(MongoNamespace namespace, WriteConcern writeConcern, boolean retryWrites, Decoder<T> decoder)	Construct a new instance.
FindAndDeleteOperation(MongoNamespace namespace, WriteConcern writeConcern, Decoder<T> decoder)	Deprecated. use FindAndDeleteOperation(MongoNamespace, WriteConcern, boolean, Decoder) instead
FindAndDeleteOperation(MongoNamespace namespace, Decoder<T> decoder)	Deprecated. use FindAndDeleteOperation(MongoNamespace, WriteConcern, boolean, Decoder) instead

Method Summary

Modifier and Type	Method	Description
FindAndDeleteOperation<T>	collation(Collation collation)	Sets the collation options
FindAndDeleteOperation<T>	filter(BsonDocument filter)	Sets the filter to apply to the query.
Collation	getCollation()	Returns the collation options
protected com.mongodb.operation.CommandOperationHelper.CommandCreator	getCommandCreator(SessionContext sessionContext)
protected String	getDatabaseName()
protected FieldNameValidator	getFieldNameValidator()
BsonDocument	getFilter()	Gets the query filter.
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time on the server for this operation.
BsonDocument	getProjection()	Gets a document describing the fields to return for all matching documents.
BsonDocument	getSort()	Gets the sort criteria to apply to the query.
FindAndDeleteOperation<T>	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
FindAndDeleteOperation<T>	projection(BsonDocument projection)	Sets a document describing the fields to return for all matching documents.
FindAndDeleteOperation<T>	sort(BsonDocument sort)	Sets the sort criteria to apply to the query.

Methods inherited from class com.mongodb.operation.BaseFindAndModifyOperation

addTxnNumberToCommand, addWriteConcernToCommand, execute, executeAsync, getDecoder, getNamespace, getWriteConcern, isRetryWrites

Methods inherited from class java.lang.Object

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

Constructor Detail

FindAndDeleteOperation

@Deprecated
public FindAndDeleteOperation(MongoNamespace namespace,
                              Decoder<T> decoder)

Deprecated. use FindAndDeleteOperation(MongoNamespace, WriteConcern, boolean, Decoder) instead

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

decoder - the decoder for the result documents.

FindAndDeleteOperation

@Deprecated
public FindAndDeleteOperation(MongoNamespace namespace,
                              WriteConcern writeConcern,
                              Decoder<T> decoder)

Deprecated. use FindAndDeleteOperation(MongoNamespace, WriteConcern, boolean, Decoder) instead

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

writeConcern - the writeConcern for the operation

decoder - the decoder for the result documents.

Since:

3.2

FindAndDeleteOperation

public FindAndDeleteOperation(MongoNamespace namespace,
                              WriteConcern writeConcern,
                              boolean retryWrites,
                              Decoder<T> decoder)

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

writeConcern - the writeConcern for the operation

retryWrites - if writes should be retried if they fail due to a network error.

decoder - the decoder for the result documents.

Since:

3.6

Method Detail

getFilter

public BsonDocument getFilter()

Gets the query filter.

Returns:

the query filter

MongoDB documentation

Filter

filter

public FindAndDeleteOperation<T> filter(BsonDocument filter)

Sets the filter to apply to the query.

Parameters:

filter - the filter, which may be null.

Returns:

this

MongoDB documentation

Filter

getProjection

public BsonDocument 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 FindAndDeleteOperation<T> projection(BsonDocument 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

getMaxTime

public long getMaxTime(TimeUnit timeUnit)

Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.

Parameters:

timeUnit - the time unit to return the result in

Returns:

the maximum execution time in the given time unit

maxTime

public FindAndDeleteOperation<T> 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

getSort

public BsonDocument 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 FindAndDeleteOperation<T> sort(BsonDocument sort)

Sets the sort criteria to apply to the query.

Parameters:

sort - the sort criteria, which may be null.

Returns:

this

MongoDB documentation

Sort

getCollation

public Collation getCollation()

Returns the collation options

Returns:

the collation options

Since:

3.4

Since server release

3.4

collation

public FindAndDeleteOperation<T> collation(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

getDatabaseName

protected String getDatabaseName()

Specified by:

getDatabaseName in class BaseFindAndModifyOperation<T>

getCommandCreator

protected com.mongodb.operation.CommandOperationHelper.CommandCreator getCommandCreator(SessionContext sessionContext)

Specified by:

getCommandCreator in class BaseFindAndModifyOperation<T>

getFieldNameValidator

protected FieldNameValidator getFieldNameValidator()

Specified by:

getFieldNameValidator in class BaseFindAndModifyOperation<T>