From 5fafaa4de1af618a3f6dc7172e9d39b9ee5fa6cd Mon Sep 17 00:00:00 2001
From: Mark Paluch <mark.paluch@broadcom.com>
Date: Tue, 20 Aug 2024 14:47:34 +0200
Subject: [PATCH] Polishing.

Revise nullability requirements around non-nullable specifications.

Original Pull Request: #3578
---
 .../support/SimpleJpaRepository.java          | 32 +++++++++++--------
 1 file changed, 19 insertions(+), 13 deletions(-)

diff --git a/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/SimpleJpaRepository.java b/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/SimpleJpaRepository.java
index a32416b233..7f1d9ce651 100644
--- a/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/SimpleJpaRepository.java
+++ b/spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/SimpleJpaRepository.java
@@ -505,6 +505,7 @@ public <S extends T, R> R findBy(Specification<T> spec, Function<FetchableFluent
 		return doFindBy(spec, getDomainClass(), queryFunction);
 	}
 
+	@SuppressWarnings("unchecked")
 	private <S extends T, R> R doFindBy(Specification<T> spec, Class<T> domainClass,
 			Function<FetchableFluentQuery<S>, R> queryFunction) {
 
@@ -594,6 +595,7 @@ public <S extends T> Page<S> findAll(Example<S> example, Pageable pageable) {
 	}
 
 	@Override
+	@SuppressWarnings("unchecked")
 	public <S extends T, R> R findBy(Example<S> example, Function<FetchableFluentQuery<S>, R> queryFunction) {
 
 		Assert.notNull(example, EXAMPLE_MUST_NOT_BE_NULL);
@@ -616,7 +618,7 @@ public long count() {
 	}
 
 	@Override
-	public long count(@Nullable Specification<T> spec) {
+	public long count(Specification<T> spec) {
 		return executeCountQuery(getCountQuery(spec, getDomainClass()));
 	}
 
@@ -685,7 +687,7 @@ public void flush() {
 	 * @deprecated use {@link #readPage(TypedQuery, Class, Pageable, Specification)} instead
 	 */
 	@Deprecated
-	protected Page<T> readPage(TypedQuery<T> query, Pageable pageable, @Nullable Specification<T> spec) {
+	protected Page<T> readPage(TypedQuery<T> query, Pageable pageable, Specification<T> spec) {
 		return readPage(query, getDomainClass(), pageable, spec);
 	}
 
@@ -695,11 +697,13 @@ protected Page<T> readPage(TypedQuery<T> query, Pageable pageable, @Nullable Spe
 	 *
 	 * @param query must not be {@literal null}.
 	 * @param domainClass must not be {@literal null}.
-	 * @param spec can be {@literal null}.
+	 * @param spec must not be {@literal null}.
 	 * @param pageable can be {@literal null}.
 	 */
 	protected <S extends T> Page<S> readPage(TypedQuery<S> query, final Class<S> domainClass, Pageable pageable,
-			@Nullable Specification<S> spec) {
+			Specification<S> spec) {
+
+		Assert.notNull(spec, "Specification must not be null");
 
 		if (pageable.isPaged()) {
 			query.setFirstResult(PageableUtils.getOffsetAsInteger(pageable));
@@ -713,10 +717,10 @@ protected <S extends T> Page<S> readPage(TypedQuery<S> query, final Class<S> dom
 	/**
 	 * Creates a new {@link TypedQuery} from the given {@link Specification}.
 	 *
-	 * @param spec can be {@literal null}.
+	 * @param spec must not be {@literal null}.
 	 * @param pageable must not be {@literal null}.
 	 */
-	protected TypedQuery<T> getQuery(@Nullable Specification<T> spec, Pageable pageable) {
+	protected TypedQuery<T> getQuery(Specification<T> spec, Pageable pageable) {
 
 		return getQuery(spec, getDomainClass(), pageable.getSort());
 	}
@@ -724,11 +728,11 @@ protected TypedQuery<T> getQuery(@Nullable Specification<T> spec, Pageable pagea
 	/**
 	 * Creates a new {@link TypedQuery} from the given {@link Specification}.
 	 *
-	 * @param spec can be {@literal null}.
+	 * @param spec must not be {@literal null}.
 	 * @param domainClass must not be {@literal null}.
 	 * @param pageable must not be {@literal null}.
 	 */
-	protected <S extends T> TypedQuery<S> getQuery(@Nullable Specification<S> spec, Class<S> domainClass,
+	protected <S extends T> TypedQuery<S> getQuery(Specification<S> spec, Class<S> domainClass,
 			Pageable pageable) {
 
 		return getQuery(spec, domainClass, pageable.getSort());
@@ -856,21 +860,23 @@ protected <S> Query getDelete(DeleteSpecification<S> spec, Class<S> domainClass)
 	/**
 	 * Creates a new count query for the given {@link Specification}.
 	 *
-	 * @param spec can be {@literal null}.
+	 * @param spec must not be {@literal null}.
 	 * @deprecated override {@link #getCountQuery(Specification, Class)} instead
 	 */
 	@Deprecated
-	protected TypedQuery<Long> getCountQuery(@Nullable Specification<T> spec) {
+	protected TypedQuery<Long> getCountQuery(Specification<T> spec) {
 		return getCountQuery(spec, getDomainClass());
 	}
 
 	/**
 	 * Creates a new count query for the given {@link Specification}.
 	 *
-	 * @param spec can be {@literal null}.
+	 * @param spec must not be {@literal null}.
 	 * @param domainClass must not be {@literal null}.
 	 */
-	protected <S extends T> TypedQuery<Long> getCountQuery(@Nullable Specification<S> spec, Class<S> domainClass) {
+	protected <S extends T> TypedQuery<Long> getCountQuery(Specification<S> spec, Class<S> domainClass) {
+
+		Assert.notNull(spec, "Specification must not be null");
 
 		CriteriaBuilder builder = entityManager.getCriteriaBuilder();
 		CriteriaQuery<Long> query = builder.createQuery(Long.class);
@@ -1020,7 +1026,7 @@ private Map<String, Object> getHints() {
 	private void applyComment(CrudMethodMetadata metadata, BiConsumer<String, Object> consumer) {
 
 		if (metadata.getComment() != null && provider.getCommentHintKey() != null) {
-			consumer.accept(provider.getCommentHintKey(), provider.getCommentHintValue(this.metadata.getComment()));
+			consumer.accept(provider.getCommentHintKey(), provider.getCommentHintValue(metadata.getComment()));
 		}
 	}