diff --git a/src/main/java/org/springframework/data/repository/PagingAndSortingRepository.java b/src/main/java/org/springframework/data/repository/PagingAndSortingRepository.java index 7fe7f7b0c..176b85341 100644 --- a/src/main/java/org/springframework/data/repository/PagingAndSortingRepository.java +++ b/src/main/java/org/springframework/data/repository/PagingAndSortingRepository.java @@ -34,15 +34,17 @@ public interface PagingAndSortingRepository extends CrudRepository /** * Returns all entities sorted by the given options. * - * @param sort + * @param sort the {@link Sort} specification to sort the results by, can be {@link Sort#unsorted()}, must not be + * {@literal null}. * @return all entities sorted by the given options */ Iterable findAll(Sort sort); /** - * Returns a {@link Page} of entities meeting the paging restriction provided in the {@code Pageable} object. + * Returns a {@link Page} of entities meeting the paging restriction provided in the {@link Pageable} object. * - * @param pageable must not be {@literal null}. + * @param pageable the pageable to request a paged result, can be {@link Pageable#unpaged()}, must not be + * {@literal null}. * @return a page of entities */ Page findAll(Pageable pageable); diff --git a/src/main/java/org/springframework/data/repository/history/RevisionRepository.java b/src/main/java/org/springframework/data/repository/history/RevisionRepository.java index db277b6b6..03bc0c35d 100755 --- a/src/main/java/org/springframework/data/repository/history/RevisionRepository.java +++ b/src/main/java/org/springframework/data/repository/history/RevisionRepository.java @@ -55,7 +55,8 @@ public interface RevisionRepository> ext * implementations have to support sorting by all properties. * * @param id must not be {@literal null}. - * @param pageable + * @param pageable the pageable to request a paged result, can be {@link Pageable#unpaged()}, must not be + * {@literal null}. * @see RevisionSort * @return */ diff --git a/src/main/java/org/springframework/data/repository/query/QueryByExampleExecutor.java b/src/main/java/org/springframework/data/repository/query/QueryByExampleExecutor.java index eb804cb09..d524aaf60 100644 --- a/src/main/java/org/springframework/data/repository/query/QueryByExampleExecutor.java +++ b/src/main/java/org/springframework/data/repository/query/QueryByExampleExecutor.java @@ -56,7 +56,8 @@ public interface QueryByExampleExecutor { * found an empty {@link Iterable} is returned. * * @param example must not be {@literal null}. - * @param sort the {@link Sort} specification to sort the results by, must not be {@literal null}. + * @param sort the {@link Sort} specification to sort the results by, may be {@link Sort#unsorted()}, must not be + * {@literal null}. * @return all entities matching the given {@link Example}. * @since 1.10 */ @@ -67,7 +68,8 @@ public interface QueryByExampleExecutor { * {@link Page} is returned. * * @param example must not be {@literal null}. - * @param pageable must not be {@literal null}. + * @param pageable the pageable to request a paged result, can be {@link Pageable#unpaged()}, must not be + * {@literal null}. * @return a {@link Page} of entities matching the given {@link Example}. */ Page findAll(Example example, Pageable pageable); diff --git a/src/main/java/org/springframework/data/repository/query/ReactiveQueryByExampleExecutor.java b/src/main/java/org/springframework/data/repository/query/ReactiveQueryByExampleExecutor.java index e45a2d8cf..0ed66aa7f 100644 --- a/src/main/java/org/springframework/data/repository/query/ReactiveQueryByExampleExecutor.java +++ b/src/main/java/org/springframework/data/repository/query/ReactiveQueryByExampleExecutor.java @@ -55,7 +55,8 @@ public interface ReactiveQueryByExampleExecutor { * found {@link Flux#empty()} is returned. * * @param example must not be {@literal null}. - * @param sort the {@link Sort} specification to sort the results by, must not be {@literal null}. + * @param sort the {@link Sort} specification to sort the results by, may be {@link Sort#unsorted()}, must not be + * {@literal null}. * @return all entities matching the given {@link Example}. */ Flux findAll(Example example, Sort sort); diff --git a/src/main/java/org/springframework/data/repository/reactive/ReactiveSortingRepository.java b/src/main/java/org/springframework/data/repository/reactive/ReactiveSortingRepository.java index 2b2e903fb..1a7bdb37f 100644 --- a/src/main/java/org/springframework/data/repository/reactive/ReactiveSortingRepository.java +++ b/src/main/java/org/springframework/data/repository/reactive/ReactiveSortingRepository.java @@ -38,7 +38,8 @@ public interface ReactiveSortingRepository extends ReactiveCrudRepository /** * Returns all entities sorted by the given options. * - * @param sort must not be {@literal null}. + * @param sort the {@link Sort} specification to sort the results by, can be {@link Sort#unsorted()}, must not be + * {@literal null}. * @return all entities sorted by the given options. * @throws IllegalArgumentException in case the given {@link Sort} is {@literal null}. */ diff --git a/src/main/java/org/springframework/data/repository/reactive/RxJava2SortingRepository.java b/src/main/java/org/springframework/data/repository/reactive/RxJava2SortingRepository.java index 55577681f..7b87f2a21 100644 --- a/src/main/java/org/springframework/data/repository/reactive/RxJava2SortingRepository.java +++ b/src/main/java/org/springframework/data/repository/reactive/RxJava2SortingRepository.java @@ -36,7 +36,8 @@ public interface RxJava2SortingRepository extends RxJava2CrudRepository findAll(Sort sort); diff --git a/src/main/java/org/springframework/data/repository/reactive/RxJava3SortingRepository.java b/src/main/java/org/springframework/data/repository/reactive/RxJava3SortingRepository.java index ec972baa9..e4cb19da5 100644 --- a/src/main/java/org/springframework/data/repository/reactive/RxJava3SortingRepository.java +++ b/src/main/java/org/springframework/data/repository/reactive/RxJava3SortingRepository.java @@ -36,7 +36,8 @@ public interface RxJava3SortingRepository extends RxJava3CrudRepository findAll(Sort sort); diff --git a/src/main/java/org/springframework/data/repository/support/RepositoryInvoker.java b/src/main/java/org/springframework/data/repository/support/RepositoryInvoker.java index db80cfb7d..a22b54386 100644 --- a/src/main/java/org/springframework/data/repository/support/RepositoryInvoker.java +++ b/src/main/java/org/springframework/data/repository/support/RepositoryInvoker.java @@ -60,7 +60,7 @@ public interface RepositoryInvoker extends RepositoryInvocationInformation { * contained in the given {@link Pageable}) or the plain equivalent to * {@link org.springframework.data.repository.CrudRepository#findAll()}. * - * @param pageable can be {@literal null}. + * @param pageable must not be {@literal null}. * @return the result of the invocation of the find-all method. * @throws IllegalStateException if the repository does not expose a find-all-method. */ @@ -72,7 +72,7 @@ public interface RepositoryInvoker extends RepositoryInvocationInformation { * {@link org.springframework.data.repository.PagingAndSortingRepository#findAll(Sort)}) or the plain equivalent to * {@link org.springframework.data.repository.CrudRepository#findAll()}. * - * @param pageable can be {@literal null}. + * @param sort must not be {@literal null}. * @return the result of the invocation of the find-all method. * @throws IllegalStateException if the repository does not expose a find-all-method. */