org.springframework.data.mongodb.core

Interface ExecutableRemoveOperation

All Known Subinterfaces:

FluentMongoOperations, MongoOperations

All Known Implementing Classes:

MongoTemplate

public interface ExecutableRemoveOperation

ExecutableRemoveOperation allows creation and execution of MongoDB remove / findAndRemove operations in a fluent API style.
The starting domainType is used for mapping the Query provided via matching into the MongoDB specific representation. The collection to operate on is by default derived from the initial domainType and can be defined there via Document. Using inCollection allows to override the collection name for the execution.

     
         remove(Jedi.class)
             .inCollection("star-wars")
             .matching(query(where("firstname").is("luke")))
             .all();
     
 

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ExecutableRemoveOperation.ExecutableRemove<T>
static interface	ExecutableRemoveOperation.RemoveWithCollection<T> Collection override (optional).
static interface	ExecutableRemoveOperation.RemoveWithQuery<T>
static interface	ExecutableRemoveOperation.TerminatingRemove<T>

Method Summary

Modifier and Type	Method and Description
<T> ExecutableRemoveOperation.ExecutableRemove<T>	remove(Class<T> domainType) Start creating a remove operation for the given domainType.

Method Detail

remove

<T> ExecutableRemoveOperation.ExecutableRemove<T> remove(Class<T> domainType)

Start creating a remove operation for the given domainType.

Parameters:

domainType - must not be null.

Returns:

new instance of ExecutableRemoveOperation.ExecutableRemove.

Throws:

IllegalArgumentException - if domainType is null.