com.mongodb.operation

Class FindAndDeleteOperation<T>

java.lang.Object

com.mongodb.operation.FindAndDeleteOperation<T>

Type Parameters:

T - the operations result type.

All Implemented Interfaces:

AsyncWriteOperation<T>, WriteOperation<T>

public class FindAndDeleteOperation<T>
extends Object
implements AsyncWriteOperation<T>, WriteOperation<T>

An operation that atomically finds and deletes a single document.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
FindAndDeleteOperation(MongoNamespace namespace, Decoder<T> decoder) Construct a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
T	execute(WriteBinding binding) General execute which can return anything of type T
void	executeAsync(AsyncWriteBinding binding, SingleResultCallback<T> callback) General execute which can return anything of type T
FindAndDeleteOperation<T>	filter(BsonDocument filter) Sets the filter to apply to the query.
Decoder<T>	getDecoder() Gets the decoder used to decode the result documents.
BsonDocument	getFilter() Gets the query filter.
long	getMaxTime(TimeUnit timeUnit) Gets the maximum execution time on the server for this operation.
MongoNamespace	getNamespace() Gets the namespace.
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 java.lang.Object

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

Constructor Detail

FindAndDeleteOperation

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

Construct a new instance.

Parameters:

namespace - the database and collection namespace for the operation.

decoder - the decoder for the result documents.

Method Detail

getNamespace

public MongoNamespace getNamespace()

Gets the namespace.

Returns:

the namespace

getDecoder

public Decoder<T> getDecoder()

Gets the decoder used to decode the result documents.

Returns:

the decoder

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

execute

public T execute(WriteBinding binding)

Description copied from interface: WriteOperation

General execute which can return anything of type T

Specified by:

execute in interface WriteOperation<T>

Parameters:

binding - the binding to execute in the context of

Returns:

T, the result of the execution

executeAsync

public void executeAsync(AsyncWriteBinding binding,
                SingleResultCallback<T> callback)

Description copied from interface: AsyncWriteOperation

General execute which can return anything of type T

Specified by:

executeAsync in interface AsyncWriteOperation<T>

Parameters:

binding - the binding to execute in the context of

callback - the callback to be called when the operation has been executed