From 18d73052ef2a444b6a466d5d18912649d39941c0 Mon Sep 17 00:00:00 2001
From: John Blum <jblum@pivotal.io>
Date: Thu, 24 Sep 2020 12:04:42 -0700
Subject: [PATCH] DATAGEODE-306 - Add requireObject(..) methods to SpringUtils.

Adds requireObject(obj:T, message:String) and requireObject(:Supplier<T>, message:String) to SpringUtils to assert that an Object reference is not null, returning the Object if not null or throwing an IllegalStateException if the Object reference is null.
---
 .../data/gemfire/util/SpringUtils.java        | 26 ++++++++++++++-----
 .../gemfire/util/SpringUtilsUnitTests.java    | 20 ++++++++++++++
 2 files changed, 39 insertions(+), 7 deletions(-)

diff --git a/spring-data-geode/src/main/java/org/springframework/data/gemfire/util/SpringUtils.java b/spring-data-geode/src/main/java/org/springframework/data/gemfire/util/SpringUtils.java
index 39f511a5..c61479d2 100644
--- a/spring-data-geode/src/main/java/org/springframework/data/gemfire/util/SpringUtils.java
+++ b/spring-data-geode/src/main/java/org/springframework/data/gemfire/util/SpringUtils.java
@@ -16,8 +16,6 @@
  */
 package org.springframework.data.gemfire.util;
 
-import static org.springframework.data.gemfire.util.ArrayUtils.nullSafeArray;
-
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -74,7 +72,8 @@ public abstract class SpringUtils {
 	 * Determines whether a given bean registered in the {@link BeanFactory Spring container} matches by
 	 * both {@link String name} and {@link Class type}.
 	 *
-	 * @param beanFactory {@link BeanFactory Spring container} in which to resolve the bean.
+	 * @param beanFactory {@link BeanFactory Spring container} in which to resolve the bean;
+	 * must not be {@literal null}.
 	 * @param beanName {@link String name} of the bean.
 	 * @param beanType {@link Class type} of the bean.
 	 * @return a boolean value indicating whether the {@link BeanFactory Spring container} contains a bean
@@ -90,9 +89,9 @@ public abstract class SpringUtils {
 	/**
 	 * Adds an array of bean dependencies (by name) to the given {@link BeanDefinition}.
 	 *
-	 * @param beanDefinition {@link BeanDefinition} to add the bean dependencies to.
-	 * @param beanNames {@link String} array containing names of beans to which the {@link BeanDefinition}
-	 * has a dependency.
+	 * @param beanDefinition {@link BeanDefinition} to add the bean dependencies to; must not be {@literal null}.
+	 * @param beanNames {@link String} array containing names of beans for which the {@link BeanDefinition}
+	 * depends on (or has a dependency).
 	 * @return the given {@link BeanDefinition}.
 	 * @see org.springframework.beans.factory.config.BeanDefinition
 	 */
@@ -102,7 +101,7 @@ public abstract class SpringUtils {
 		List<String> dependsOnList = new ArrayList<>();
 
 		Collections.addAll(dependsOnList, ArrayUtils.nullSafeArray(beanDefinition.getDependsOn(), String.class));
-		dependsOnList.addAll(Arrays.asList(nullSafeArray(beanNames, String.class)));
+		dependsOnList.addAll(Arrays.asList(ArrayUtils.nullSafeArray(beanNames, String.class)));
 		beanDefinition.setDependsOn(dependsOnList.toArray(new String[0]));
 
 		return beanDefinition;
@@ -322,6 +321,19 @@ public abstract class SpringUtils {
 		return target != null ? target.getClass() : defaultType;
 	}
 
+	public static <T> T requireObject(@Nullable T object, String message) {
+		return requireObject(() -> object, message);
+	}
+
+	public static <T> T requireObject(@NonNull Supplier<T> objectSupplier, String message) {
+
+		T object = objectSupplier != null ? objectSupplier.get() : null;
+
+		Assert.state(object != null, message);
+
+		return object;
+	}
+
 	public static boolean safeDoOperation(VoidReturningThrowableOperation operation) {
 		return safeDoOperation(operation, () -> {});
 	}
diff --git a/spring-data-geode/src/test/java/org/springframework/data/gemfire/util/SpringUtilsUnitTests.java b/spring-data-geode/src/test/java/org/springframework/data/gemfire/util/SpringUtilsUnitTests.java
index 6fe21870..384fc788 100644
--- a/spring-data-geode/src/test/java/org/springframework/data/gemfire/util/SpringUtilsUnitTests.java
+++ b/spring-data-geode/src/test/java/org/springframework/data/gemfire/util/SpringUtilsUnitTests.java
@@ -436,6 +436,26 @@ public class SpringUtilsUnitTests {
 		assertThat(SpringUtils.nullSafeType(null, Person.class)).isEqualTo(Person.class);
 	}
 
+	@Test
+	public void requireObjectReturnsObject() {
+		assertThat(SpringUtils.requireObject("TEST", "Test Object must not be null")).isEqualTo("TEST");
+	}
+
+	@Test(expected = IllegalStateException.class)
+	public void requireObjectWithNullObjectThrowsIllegalStateException() {
+
+		try {
+			SpringUtils.requireObject(null, "Test Object must not be null");
+		}
+		catch (IllegalStateException expected) {
+
+			assertThat(expected).hasMessage("Test Object must not be null");
+			assertThat(expected).hasNoCause();
+
+			throw expected;
+		}
+	}
+
 	@Test
 	public void safeDoOperationWithNonThrowingOperation() {