org.springframework.data.jpa.repository

Interface JpaSpecificationExecutor<T>

All Known Subinterfaces:

JpaRepositoryImplementation<T,ID>

All Known Implementing Classes:

QuerydslJpaRepository, SimpleJpaRepository

public interface JpaSpecificationExecutor<T>

Interface to allow execution of Specifications based on the JPA criteria API.

Author:

Oliver Gierke, Christoph Strobl

Method Summary

Modifier and Type	Method and Description
long	count(Specification<T> spec) Returns the number of instances that the given Specification will return.
List<T>	findAll(Specification<T> spec) Returns all entities matching the given Specification.
Page<T>	findAll(Specification<T> spec, Pageable pageable) Returns a Page of entities matching the given Specification.
List<T>	findAll(Specification<T> spec, Sort sort) Returns all entities matching the given Specification and Sort.
Optional<T>	findOne(Specification<T> spec) Returns a single entity matching the given Specification or Optional.empty() if none found.

Method Detail

findOne

Optional<T> findOne(@Nullable
                    Specification<T> spec)

Returns a single entity matching the given Specification or Optional.empty() if none found.

Parameters:

spec - can be null.

Returns:

never null.

Throws:

IncorrectResultSizeDataAccessException - if more than one entity found.

findAll

List<T> findAll(@Nullable
                Specification<T> spec)

Returns all entities matching the given Specification.

Parameters:

spec - can be null.

Returns:

never null.

findAll

Page<T> findAll(@Nullable
                Specification<T> spec,
                Pageable pageable)

Returns a Page of entities matching the given Specification.

Parameters:

spec - can be null.

pageable - must not be null.

Returns:

never null.

findAll

List<T> findAll(@Nullable
                Specification<T> spec,
                Sort sort)

Returns all entities matching the given Specification and Sort.

Parameters:

spec - can be null.

sort - must not be null.

Returns:

never null.

count

long count(@Nullable
           Specification<T> spec)

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

Parameters:

spec - the Specification to count instances for. Can be null.

Returns:

the number of instances.