Package io.micronaut.data.repository.jpa.async

Interface AsyncJpaSpecificationExecutor<T>

Type Parameters:

T - The entity type

public interface AsyncJpaSpecificationExecutor<T>

Interface representing async version of JpaSpecificationExecutor.

Since:

3.2

Author:

Denis Stepanov

Method Summary

Modifier and Type	Method	Description
@NonNull CompletableFuture<Long>	count(@Nullable PredicateSpecification<T> spec)	Returns the number of instances that the given QuerySpecification will return.
@NonNull CompletableFuture<Long>	count(@Nullable QuerySpecification<T> spec)	Returns the number of instances that the given QuerySpecification will return.
@NonNull CompletableFuture<Long>	deleteAll(@Nullable DeleteSpecification<T> spec)	Deletes all entities matching the given DeleteSpecification.
@NonNull CompletableFuture<Long>	deleteAll(@Nullable PredicateSpecification<T> spec)	Deletes all entities matching the given PredicateSpecification.
@NonNull CompletableFuture<Boolean>	exists(@Nullable PredicateSpecification<T> spec)	Returns whether an instance was found for the given PredicateSpecification.
@NonNull CompletableFuture<Boolean>	exists(@Nullable QuerySpecification<T> spec)	Returns whether an instance was found for the given QuerySpecification.
<S extends T> @NonNull CompletableFuture<? extends List<S>>	findAll(@Nullable PredicateSpecification<T> spec)	Returns all entities matching the given PredicateSpecification.
@NonNull CompletableFuture<Page<T>>	findAll(@Nullable PredicateSpecification<T> spec, Pageable pageable)	Returns a Page of entities matching the given PredicateSpecification.
<S extends T> @NonNull CompletableFuture<? extends List<S>>	findAll(@Nullable PredicateSpecification<T> spec, Sort sort)	Returns all entities matching the given QuerySpecification and Sort.
<S extends T> @NonNull CompletableFuture<? extends List<S>>	findAll(@Nullable QuerySpecification<T> spec)	Returns all entities matching the given QuerySpecification.
@NonNull CompletableFuture<Page<T>>	findAll(@Nullable QuerySpecification<T> spec, Pageable pageable)	Returns a Page of entities matching the given QuerySpecification.
<S extends T> @NonNull CompletableFuture<? extends List<S>>	findAll(@Nullable QuerySpecification<T> spec, Sort sort)	Returns all entities matching the given QuerySpecification and Sort.
<S extends T> @NonNull CompletableFuture<S>	findOne(@Nullable PredicateSpecification<T> spec)	Returns a single entity matching the given PredicateSpecification.
<S extends T> @NonNull CompletableFuture<S>	findOne(@Nullable QuerySpecification<T> spec)	Returns a single entity matching the given QuerySpecification.
@NonNull CompletableFuture<Long>	updateAll(@Nullable UpdateSpecification<T> spec)	Updates all entities matching the given UpdateSpecification.

Method Details

findOne

@NonNull
<S extends T> @NonNull CompletableFuture<S> findOne(@Nullable
 @Nullable QuerySpecification<T> spec)

Returns a single entity matching the given QuerySpecification.

Type Parameters:

S - The entity type

Parameters:

spec - The query specification

Returns:

optional found result

findOne

@NonNull
<S extends T> @NonNull CompletableFuture<S> findOne(@Nullable
 @Nullable PredicateSpecification<T> spec)

Returns a single entity matching the given PredicateSpecification.

Type Parameters:

S - The result type

Parameters:

spec - The query specification

Returns:

optional found result

findAll

@NonNull
<S extends T>
@NonNull CompletableFuture<? extends List<S>> findAll(@Nullable
 @Nullable QuerySpecification<T> spec)

Returns all entities matching the given QuerySpecification.

Type Parameters:

S - The result type

Parameters:

spec - The query specification

Returns:

found results

findAll

@NonNull
<S extends T>
@NonNull CompletableFuture<? extends List<S>> findAll(@Nullable
 @Nullable PredicateSpecification<T> spec)

Returns all entities matching the given PredicateSpecification.

Type Parameters:

S - The result type

Parameters:

spec - The query specification

Returns:

found results

findAll

@NonNull
@NonNull CompletableFuture<Page<T>> findAll(@Nullable
 @Nullable QuerySpecification<T> spec,
 Pageable pageable)

Returns a Page of entities matching the given QuerySpecification.

Parameters:

spec - The query specification

pageable - The pageable object

Returns:

a page

findAll

@NonNull
@NonNull CompletableFuture<Page<T>> findAll(@Nullable
 @Nullable PredicateSpecification<T> spec,
 Pageable pageable)

Returns a Page of entities matching the given PredicateSpecification.

Parameters:

spec - The query specification

pageable - The pageable object

Returns:

a page

findAll

@NonNull
<S extends T>
@NonNull CompletableFuture<? extends List<S>> findAll(@Nullable
 @Nullable QuerySpecification<T> spec,
 Sort sort)

Returns all entities matching the given QuerySpecification and Sort.

Type Parameters:

S - The result type

Parameters:

spec - The query specification

sort - The sort object

Returns:

found results

findAll

@NonNull
<S extends T>
@NonNull CompletableFuture<? extends List<S>> findAll(@Nullable
 @Nullable PredicateSpecification<T> spec,
 Sort sort)

Returns all entities matching the given QuerySpecification and Sort.

Type Parameters:

S - The result type

Parameters:

spec - The query specification

sort - The sort object

Returns:

found results

count

@NonNull
@NonNull CompletableFuture<Long> count(@Nullable
 @Nullable QuerySpecification<T> spec)

Returns the number of instances that the given QuerySpecification will return.

Parameters:

spec - The query specification

Returns:

the number of instances.

count

@NonNull
@NonNull CompletableFuture<Long> count(@Nullable
 @Nullable PredicateSpecification<T> spec)

Returns the number of instances that the given QuerySpecification will return.

Parameters:

spec - The query specification

Returns:

the number of instances.

exists

@NonNull
@NonNull CompletableFuture<Boolean> exists(@Nullable
 @Nullable QuerySpecification<T> spec)

Returns whether an instance was found for the given QuerySpecification.

Parameters:

spec - The query specification

Returns:

the number of instances.

Since:

3.8

exists

@NonNull
@NonNull CompletableFuture<Boolean> exists(@Nullable
 @Nullable PredicateSpecification<T> spec)

Returns whether an instance was found for the given PredicateSpecification.

Parameters:

spec - The query specification

Returns:

the number of instances.

Since:

3.8

deleteAll

@NonNull
@NonNull CompletableFuture<Long> deleteAll(@Nullable
 @Nullable DeleteSpecification<T> spec)

Deletes all entities matching the given DeleteSpecification.

Parameters:

spec - The delete specification

Returns:

the number records deleted.

deleteAll

@NonNull
@NonNull CompletableFuture<Long> deleteAll(@Nullable
 @Nullable PredicateSpecification<T> spec)

Deletes all entities matching the given PredicateSpecification.

Parameters:

spec - The delete specification

Returns:

the number records deleted.

updateAll

@NonNull
@NonNull CompletableFuture<Long> updateAll(@Nullable
 @Nullable UpdateSpecification<T> spec)

Updates all entities matching the given UpdateSpecification.

Parameters:

spec - The update specification

Returns:

the number records updated.