Interface AsyncCrudRepository<T,ID>
- Type Parameters:
T
- the domain type the repository managesID
- the type of the id of the entity the repository manages
- All Superinterfaces:
org.springframework.data.repository.Repository<T,
ID>
- All Known Subinterfaces:
CoherenceAsyncRepository<T,
ID>
public interface AsyncCrudRepository<T,ID>
extends org.springframework.data.repository.Repository<T,ID>
Asynchronous version of
CrudRepository
.- Since:
- 3.0
- Author:
- Ryan Lubke
-
Method Summary
Modifier and TypeMethodDescriptioncount()
Returns the number of entities available.Deletes a given entity.Deletes all entities managed by the repository.Deletes the given entities.deleteAllById
(Iterable<? extends ID> ids) Deletes all instances of the typeT
with the given IDs.deleteById
(ID id) Deletes the entity with the given id.existsById
(ID id) Returns whether an entity with the given id exists.findAll()
Returns all instances of the type.findAllById
(Iterable<ID> ids) Returns all instances of the typeT
with the given IDs.Retrieves an entity by its id.<S extends T>
CompletableFuture<S>save
(S entity) Saves a given entity.<S extends T>
CompletableFuture<Iterable<S>>Saves all given entities.
-
Method Details
-
save
Saves a given entity. Use the returned instance for further operations as the save operation might have changed the entity instance completely.- Type Parameters:
S
- the entity type- Parameters:
entity
- must not be null- Returns:
- the saved entity; will never be null
- Throws:
IllegalArgumentException
- in case the given entity is null
-
saveAll
Saves all given entities.- Type Parameters:
S
- the entity type- Parameters:
entities
- must not be null nor must it contain null- Returns:
- the saved entities; will never be null. The returned Iterable will have the same size as the Iterable passed as an argument
- Throws:
IllegalArgumentException
- in case the givenentities
or one of its entities is null
-
findById
Retrieves an entity by its id.- Parameters:
id
- must not be null- Returns:
- the entity with the given id or Optional#empty() if none found
- Throws:
IllegalArgumentException
- if id is null
-
existsById
Returns whether an entity with the given id exists.- Parameters:
id
- must not be null- Returns:
- true if an entity with the given id exists, false otherwise
- Throws:
IllegalArgumentException
- if id is null
-
findAll
CompletableFuture<Iterable<T>> findAll()Returns all instances of the type.- Returns:
- all entities
-
findAllById
Returns all instances of the typeT
with the given IDs.If some or all ids are not found, no entities are returned for these IDs.
Note that the order of elements in the result is not guaranteed.
- Parameters:
ids
- must not be null nor contain any null values- Returns:
- guaranteed to be not null. The size can be equal or less than the number of given ids
- Throws:
IllegalArgumentException
- in case the givenids
or one of its items is null
-
count
CompletableFuture<Long> count()Returns the number of entities available.- Returns:
- the number of entities
-
deleteById
Deletes the entity with the given id.- Parameters:
id
- must not be null- Returns:
- a CompletableFuture that can be used to determine whether the operation completed
- Throws:
IllegalArgumentException
- in case the given id is null
-
delete
Deletes a given entity.- Parameters:
entity
- must not be null- Returns:
- a CompletableFuture that can be used to determine whether the operation completed
- Throws:
IllegalArgumentException
- in case the given entity is null
-
deleteAllById
Deletes all instances of the typeT
with the given IDs.- Parameters:
ids
- must not be null. Must not contain null elements- Returns:
- a CompletableFuture that can be used to determine whether the operation completed
- Throws:
IllegalArgumentException
- in case the given ids or one of its elements is null
-
deleteAll
Deletes the given entities.- Parameters:
entities
- must not be null. Must not contain null elements- Returns:
- a CompletableFuture that can be used to determine whether the operation completed
- Throws:
IllegalArgumentException
- in case the given entities or one of its entities is null
-
deleteAll
CompletableFuture<Void> deleteAll()Deletes all entities managed by the repository.- Returns:
- a CompletableFuture that can be used to determine whether the operation completed
-