org.springframework.data.gemfire.util

Class SpringUtils

java.lang.Object

org.springframework.data.gemfire.util.SpringUtils

Direct Known Subclasses:

DistributedSystemUtils

public abstract class SpringUtils
extends Object

Abstract utility class encapsulating functionality common to Objects, Class types and Spring beans.

Since:

1.8.0

Author:

John Blum

See Also:

Class, Object, Function, Stream, BeanFactory, FactoryBean, BeanDefinition, RuntimeBeanReference, Ordered, AnnotationAwareOrderComparator, Order

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpringUtils.OrderedBeanWrapper<T>
static interface	SpringUtils.ValueReturningThrowableOperation<T>
static interface	SpringUtils.VoidReturningExceptionThrowingOperation Deprecated. use SpringUtils.VoidReturningThrowableOperation.
static interface	SpringUtils.VoidReturningThrowableOperation

Constructor Summary

Constructors

Constructor and Description
SpringUtils()

Method Summary

Modifier and Type	Method and Description
static BeanDefinition	addDependsOn(BeanDefinition beanDefinition, String... beanNames) Adds an array of bean dependencies (by name) to the given BeanDefinition.
static String	defaultIfEmpty(String value, String defaultValue)
static String	defaultIfEmpty(String value, Supplier<String> supplier)
static <T> T	defaultIfNull(T value, Supplier<T> supplier)
static <T> T	defaultIfNull(T value, T defaultValue)
static String	dereferenceBean(String beanName)
static boolean	equalsIgnoreNull(Object obj1, Object obj2)
static <T> List<T>	getBeansOfTypeOrdered(ConfigurableListableBeanFactory beanFactory, Class<T> beanType) Returns a List of beans by the given type in order.
static <T> List<T>	getBeansOfTypeOrdered(ConfigurableListableBeanFactory beanFactory, Class<T> beanType, boolean includeNonSingletons, boolean allowEagerInit) Returns a List of beans by the given type in order.
static Integer	getOrder(Object target) Null-safe operation to return the order of the given Object if it is Ordered or null if the given Object is not Ordered.
static <T> Stream<T>	getOrderedStreamOfBeansByType(BeanFactory beanFactory, Class<T> beanType) Returns bean of the given type in an ordered Stream.
static Optional<Object>	getPropertyValue(BeanDefinition beanDefinition, String propertyName)
static boolean	isMatchingBean(BeanFactory beanFactory, String beanName, Class<?> beanType) Determines whether a given bean registered in the Spring container matches by both name and type.
static boolean	nullOrEquals(Object obj1, Object obj2)
static boolean	nullSafeEquals(Object obj1, Object obj2)
static String	nullSafeName(Class<?> type)
static String	nullSafeSimpleName(Class<?> type)
static Class<?>	nullSafeType(Object target)
static Class<?>	nullSafeType(Object target, Class<?> defaultType)
static <T> T	requireObject(Supplier<T> objectSupplier, String message)
static <T> T	requireObject(T object, String message)
static boolean	safeDoOperation(SpringUtils.VoidReturningThrowableOperation operation)
static boolean	safeDoOperation(SpringUtils.VoidReturningThrowableOperation operation, Runnable backupOperation)
static <T> T	safeGetValue(SpringUtils.ValueReturningThrowableOperation<T> operation)
static <T> T	safeGetValue(SpringUtils.ValueReturningThrowableOperation<T> operation, Function<Throwable,T> exceptionHandler)
static <T> T	safeGetValue(SpringUtils.ValueReturningThrowableOperation<T> operation, Supplier<T> defaultValueSupplier)
static <T> T	safeGetValue(SpringUtils.ValueReturningThrowableOperation<T> operation, T defaultValue)
static void	safeRunOperation(SpringUtils.VoidReturningThrowableOperation operation)
static void	safeRunOperation(SpringUtils.VoidReturningThrowableOperation operation, Function<Throwable,RuntimeException> exceptionConverter)
static BeanDefinition	setPropertyReference(BeanDefinition beanDefinition, String propertyName, String beanName)
static BeanDefinition	setPropertyValue(BeanDefinition beanDefinition, String propertyName, Object propertyValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpringUtils

public SpringUtils()

Method Detail

isMatchingBean

public static boolean isMatchingBean(@NonNull
                                     BeanFactory beanFactory,
                                     String beanName,
                                     Class<?> beanType)

Determines whether a given bean registered in the Spring container matches by both name and type.

Parameters:

beanFactory - Spring container in which to resolve the bean; must not be null.

beanName - name of the bean.

beanType - type of the bean.

Returns:

a boolean value indicating whether the Spring container contains a bean matching by both name and type.

See Also:

BeanFactory, Class, String

addDependsOn

@NonNull
public static BeanDefinition addDependsOn(@NonNull
                                                   BeanDefinition beanDefinition,
                                                   @Nullable
                                                   String... beanNames)

Adds an array of bean dependencies (by name) to the given BeanDefinition.

Parameters:

beanDefinition - BeanDefinition to add the bean dependencies to; must not be null.

beanNames - String array containing names of beans for which the BeanDefinition depends on (or has a dependency).

Returns:

the given BeanDefinition.

See Also:

BeanDefinition

getBeansOfTypeOrdered

@NonNull
public static <T> List<T> getBeansOfTypeOrdered(@NonNull
                                                         ConfigurableListableBeanFactory beanFactory,
                                                         @NonNull
                                                         Class<T> beanType)

Returns a List of beans by the given type in order.

Type Parameters:

T - type of the bean.

Parameters:

beanFactory - Spring container used to acquire the ordered beans.

beanType - type of beans to acquire.

Returns:

a List of beans of the given type in order.

See Also:

getBeansOfTypeOrdered(ConfigurableListableBeanFactory, Class, boolean, boolean), ConfigurableListableBeanFactory, Class, List

getBeansOfTypeOrdered

@NonNull
public static <T> List<T> getBeansOfTypeOrdered(@NonNull
                                                         ConfigurableListableBeanFactory beanFactory,
                                                         @NonNull
                                                         Class<T> beanType,
                                                         boolean includeNonSingletons,
                                                         boolean allowEagerInit)

Returns a List of beans by the given type in order.

Type Parameters:

T - type of the bean.

Parameters:

beanFactory - Spring container used to acquire the ordered beans.

beanType - type of beans to acquire.

includeNonSingletons - boolean indicating whether to include non-Singleton beans from the Spring container.

allowEagerInit - boolean indicating whether to eagerly initialize FactoryBeans.

Returns:

a List of beans of the given type in order.

See Also:

ConfigurableListableBeanFactory, Class, List

getOrder

@Nullable
public static Integer getOrder(@Nullable
                                         Object target)

Null-safe operation to return the order of the given Object if it is Ordered or null if the given Object is not Ordered.

Parameters:

target - Object to evaluate; may be null.

Returns:

the order of the given Object if Ordered, otherwise return null.

See Also:

Ordered

getOrderedStreamOfBeansByType

public static <T> Stream<T> getOrderedStreamOfBeansByType(@NonNull
                                                          BeanFactory beanFactory,
                                                          @NonNull
                                                          Class<T> beanType)

Returns bean of the given type in an ordered Stream.

Type Parameters:

T - type of the beans.

Parameters:

beanFactory - BeanFactory from which to acquire the beans.

beanType - type of the beans.

Returns:

an ordered Stream of beans from the BeanFactory of the given type.

See Also:

BeanFactory, Stream, Class

getPropertyValue

public static Optional<Object> getPropertyValue(BeanDefinition beanDefinition,
                                                String propertyName)

setPropertyReference

public static BeanDefinition setPropertyReference(BeanDefinition beanDefinition,
                                                  String propertyName,
                                                  String beanName)

setPropertyValue

public static BeanDefinition setPropertyValue(BeanDefinition beanDefinition,
                                              String propertyName,
                                              Object propertyValue)

defaultIfEmpty

public static String defaultIfEmpty(String value,
                                    String defaultValue)

defaultIfEmpty

public static String defaultIfEmpty(String value,
                                    Supplier<String> supplier)

defaultIfNull

public static <T> T defaultIfNull(T value,
                                  T defaultValue)

defaultIfNull

public static <T> T defaultIfNull(T value,
                                  Supplier<T> supplier)

dereferenceBean

public static String dereferenceBean(String beanName)

equalsIgnoreNull

public static boolean equalsIgnoreNull(Object obj1,
                                       Object obj2)

nullOrEquals

public static boolean nullOrEquals(Object obj1,
                                   Object obj2)

nullSafeEquals

public static boolean nullSafeEquals(Object obj1,
                                     Object obj2)

nullSafeName

public static String nullSafeName(Class<?> type)

nullSafeSimpleName

public static String nullSafeSimpleName(Class<?> type)

nullSafeType

public static Class<?> nullSafeType(Object target)

nullSafeType

public static Class<?> nullSafeType(Object target,
                                    Class<?> defaultType)

requireObject

public static <T> T requireObject(@Nullable
                                  T object,
                                  String message)

requireObject

public static <T> T requireObject(@NonNull
                                  Supplier<T> objectSupplier,
                                  String message)

safeDoOperation

public static boolean safeDoOperation(SpringUtils.VoidReturningThrowableOperation operation)

safeDoOperation

public static boolean safeDoOperation(SpringUtils.VoidReturningThrowableOperation operation,
                                      Runnable backupOperation)

safeGetValue

public static <T> T safeGetValue(SpringUtils.ValueReturningThrowableOperation<T> operation)

safeGetValue

public static <T> T safeGetValue(SpringUtils.ValueReturningThrowableOperation<T> operation,
                                 T defaultValue)

safeGetValue

public static <T> T safeGetValue(SpringUtils.ValueReturningThrowableOperation<T> operation,
                                 Supplier<T> defaultValueSupplier)

safeGetValue

public static <T> T safeGetValue(SpringUtils.ValueReturningThrowableOperation<T> operation,
                                 Function<Throwable,T> exceptionHandler)

safeRunOperation

public static void safeRunOperation(SpringUtils.VoidReturningThrowableOperation operation)

safeRunOperation

public static void safeRunOperation(SpringUtils.VoidReturningThrowableOperation operation,
                                    Function<Throwable,RuntimeException> exceptionConverter)