From 43bba35dec44691f8ebf7370229f538e7e0c13c2 Mon Sep 17 00:00:00 2001
From: Diego Krupitza <info@diegokrupitza.com>
Date: Tue, 15 Mar 2022 15:33:23 +0100
Subject: [PATCH] Update documentation for repository `Pageable` and `Sort`
 arguments.

Replace outdated `null` acceptance for `Pageable` with `Pageable.unpaged()`
 `QueryByExampleExecutor#findAll(Example<S> example, Pageable pageable)` should does not accept null values since there is `Pageable.unpaged()`. Furthermore, the same applies to `PagingAndSortingRepository#findAll(Pageable pageable)`.

Related ticket: spring-projects/spring-data-jpa/issues/2464
Closes #2574
---
 .../data/repository/PagingAndSortingRepository.java            | 2 +-
 .../data/repository/query/QueryByExampleExecutor.java          | 3 ++-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/springframework/data/repository/PagingAndSortingRepository.java b/src/main/java/org/springframework/data/repository/PagingAndSortingRepository.java
index 609996406..7fe7f7b0c 100644
--- a/src/main/java/org/springframework/data/repository/PagingAndSortingRepository.java
+++ b/src/main/java/org/springframework/data/repository/PagingAndSortingRepository.java
@@ -42,7 +42,7 @@ public interface PagingAndSortingRepository<T, ID> extends CrudRepository<T, ID>
 	/**
 	 * Returns a {@link Page} of entities meeting the paging restriction provided in the {@code Pageable} object.
 	 *
-	 * @param pageable
+	 * @param pageable must not be {@literal null}.
 	 * @return a page of entities
 	 */
 	Page<T> findAll(Pageable pageable);
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 33f99fe7a..6787cf4c4 100644
--- a/src/main/java/org/springframework/data/repository/query/QueryByExampleExecutor.java
+++ b/src/main/java/org/springframework/data/repository/query/QueryByExampleExecutor.java
@@ -29,6 +29,7 @@ import org.springframework.data.domain.Sort;
  * @param <T>
  * @author Mark Paluch
  * @author Christoph Strobl
+ * @author Diego Krupitza
  * @since 1.12
  */
 public interface QueryByExampleExecutor<T> {
@@ -67,7 +68,7 @@ public interface QueryByExampleExecutor<T> {
 	 * {@link Page} is returned.
 	 *
 	 * @param example must not be {@literal null}.
-	 * @param pageable can be {@literal null}.
+	 * @param pageable must not be {@literal null}.
 	 * @return a {@link Page} of entities matching the given {@link Example}.
 	 */
 	<S extends T> Page<S> findAll(Example<S> example, Pageable pageable);