Polish for #558.

Author: jxblum

spring-data-geode/src/main/java/org/springframework/data/gemfire/SubscriptionAttributesFactoryBean.java

@@ -22,16 +22,15 @@
 import org.springframework.beans.factory.InitializingBean;
 
 /**
- * The SubscriptionAttributesFactoryBean class is a Spring FactoryBean used for defining and constructing
- * a GemFire SubscriptionAttributes object, which determines the Subscription policy used by Regions to
- * declared their data interests.
+ * Spring {@link FactoryBean} used for defining and constructing an Apache Geode {@link SubscriptionAttributes} object,
+ * which determines the subscription policy used by cache Regions declaring their data interests.
  *
  * @author Lyndon Adams
  * @author John Blum
- * @see org.springframework.beans.factory.FactoryBean
- * @see org.springframework.beans.factory.InitializingBean
  * @see org.apache.geode.cache.InterestPolicy
  * @see org.apache.geode.cache.SubscriptionAttributes
+ * @see org.springframework.beans.factory.FactoryBean
+ * @see org.springframework.beans.factory.InitializingBean
  * @since 1.3.0
  */
 public class SubscriptionAttributesFactoryBean implements FactoryBean<SubscriptionAttributes>, InitializingBean {

spring-data-geode/src/main/java/org/springframework/data/gemfire/client/function/ListRegionsOnServerFunction.java

@@ -16,6 +16,7 @@
  */
 package org.springframework.data.gemfire.client.function;
 
+import java.io.Serial;
 import java.util.ArrayList;
 import java.util.List;
 
@@ -25,24 +26,28 @@
 import org.apache.geode.cache.execute.Function;
 import org.apache.geode.cache.execute.FunctionContext;
 
+import org.springframework.lang.NonNull;
+
 /**
- * ListRegionsOnServerFunction is a GemFire Function class that returns a List of names for all Regions
- * defined in the GemFire cluster.
+ * {@link ListRegionsOnServerFunction} is an Apache Geode {@link Function}
+ * returning a {@link List} of {@link String names} for all {@link Region Regions}
+ * defined in the Apache Geode cache.
  *
  * @author David Turanski
  * @author John Blum
+ * @see java.io.Serial
  * @see org.apache.geode.cache.execute.Function
  */
-@SuppressWarnings("serial")
-public class ListRegionsOnServerFunction implements Function {
+public class ListRegionsOnServerFunction implements Function<Object> {
 
+	@Serial
 	private static final long serialVersionUID = 867530169L;
 
 	public static final String ID = ListRegionsOnServerFunction.class.getName();
 
 	@Override
 	@SuppressWarnings("unchecked")
-	public void execute(FunctionContext functionContext) {
+	public void execute(@NonNull FunctionContext functionContext) {
 
 		List<String> regionNames = new ArrayList<>();
 
@@ -57,21 +62,33 @@ Cache getCache() {
 		return CacheFactory.getAnyInstance();
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	@Override
 	public String getId() {
-		return this.getClass().getName();
+		return getClass().getName();
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	@Override
 	public boolean hasResult() {
 		return true;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	@Override
 	public boolean isHA() {
 		return false;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	@Override
 	public boolean optimizeForWrite() {
 		return false;

spring-data-geode/src/main/java/org/springframework/data/gemfire/function/DefaultFunctionArgumentResolver.java

@@ -14,11 +14,18 @@
 
 import java.lang.reflect.Method;
 
+import org.apache.geode.cache.execute.Function;
 import org.apache.geode.cache.execute.FunctionContext;
 
 /**
+ * {@link FunctionArgumentResolver} used to resolve {@link Object[] arguments} passed to
+ * an Apache Geode {@link Function} during execution.
+ *
  * @author David Turanski
  * @author John Blum
+ * @see org.apache.geode.cache.execute.Function
+ * @see org.apache.geode.cache.execute.FunctionContext
+ * @see org.springframework.data.gemfire.function.FunctionArgumentResolver
  * @since 1.3.0
  */
 class DefaultFunctionArgumentResolver implements FunctionArgumentResolver {

spring-data-geode/src/main/java/org/springframework/data/gemfire/function/FunctionArgumentResolver.java

@@ -14,21 +14,24 @@
 
 import java.lang.reflect.Method;
 
+import org.apache.geode.cache.execute.Function;
 import org.apache.geode.cache.execute.FunctionContext;
 
 /**
- * The FunctionArgumentResolver interface is a Strategy Interface for resolving Function invocation arguments,
- * given a {@link FunctionContext}.
+ * The {@link FunctionArgumentResolver} interface is a {@literal Strategy} interface for resolving {@link Function}
+ * invocation arguments from the given {@link FunctionContext}.
  *
  * @author David Turanski
  * @author John Blum
+ * @see org.apache.geode.cache.execute.Function
  * @see org.apache.geode.cache.execute.FunctionContext
  * @since 1.3.0
  */
 interface FunctionArgumentResolver {
 
 	Method getFunctionAnnotatedMethod();
 
+	@SuppressWarnings("rawtypes")
 	Object[] resolveFunctionArguments(FunctionContext functionContext);
 
 }

spring-data-geode/src/main/java/org/springframework/data/gemfire/function/PdxFunctionArgumentResolver.java

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.springframework.data.gemfire.function;
 
 import java.lang.reflect.Method;
@@ -23,23 +22,25 @@
 import org.apache.geode.cache.execute.FunctionContext;
 import org.apache.geode.pdx.PdxInstance;
 
+import org.springframework.lang.NonNull;
 import org.springframework.util.ClassUtils;
 
 /**
- * The PdxFunctionArgumentResolver class is a Spring Data GemFire FunctionArgumentResolver that automatically resolves
- * PDX types when GemFire is configured with read-serialized set to true, but the application domain classes
- * are actually on the classpath.
+ * {@link PdxFunctionArgumentResolver} is a {@link FunctionArgumentResolver} that automatically resolves PDX types
+ * when Apache Geode is configured with {@literal read-serialized} set to {@literal true}, but the application
+ * domain model classes are actually on the application classpath.
  *
  * @author John Blum
- * @see org.springframework.data.gemfire.function.DefaultFunctionArgumentResolver
  * @see org.apache.geode.pdx.PdxInstance
+ * @see org.springframework.data.gemfire.function.DefaultFunctionArgumentResolver
  * @since 1.5.2
  */
 @SuppressWarnings("unused")
 class PdxFunctionArgumentResolver extends DefaultFunctionArgumentResolver {
 
 	@Override
-	public Object[] resolveFunctionArguments(final FunctionContext functionContext) {
+	@SuppressWarnings("rawtypes")
+	public Object[] resolveFunctionArguments(@NonNull FunctionContext functionContext) {
 
 		Object[] functionArguments = super.resolveFunctionArguments(functionContext);
 
@@ -70,6 +71,7 @@ public Method getFunctionAnnotatedMethod() {
 	}
 
 	boolean isPdxSerializerConfigured() {
+
 		try {
 			return (CacheFactory.getAnyInstance().getPdxSerializer() != null);
 		}
@@ -78,11 +80,6 @@ boolean isPdxSerializerConfigured() {
 		}
 	}
 
-	/*
-	 * (non-Javadac)
-	 * @see #isOnClasspath(String)
-	 * @see #functionAnnotatedMethodHasParameterOfType(String)
-	 */
 	boolean isDeserializationNecessary(final String className) {
 		return (isOnClasspath(className) && functionAnnotatedMethodHasParameterOfType(className));
 	}
@@ -92,6 +89,7 @@ boolean isOnClasspath(final String className) {
 	}
 
 	boolean functionAnnotatedMethodHasParameterOfType(final String className) {
+
 		for (Class<?> parameterType : getFunctionAnnotatedMethod().getParameterTypes()) {
 			if (parameterType.getName().equals(className)) {
 				return true;

spring-data-geode/src/main/java/org/springframework/data/gemfire/function/config/AnnotationFunctionExecutionConfigurationSource.java

@@ -23,6 +23,9 @@
 import java.util.List;
 import java.util.Set;
 
+import org.apache.geode.cache.execute.Execution;
+import org.apache.geode.cache.execute.Function;
+
 import org.springframework.beans.BeanUtils;
 import org.springframework.context.annotation.FilterType;
 import org.springframework.core.annotation.AnnotationAttributes;
@@ -31,14 +34,20 @@
 import org.springframework.core.type.filter.AssignableTypeFilter;
 import org.springframework.core.type.filter.TypeFilter;
 import org.springframework.data.gemfire.util.ArrayUtils;
+import org.springframework.lang.NonNull;
+import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
 
 /**
- * Annotation based configuration source for function executions
+ * Annotation based configuration source for {@link Function} {@link Execution Executions}.
  *
  * @author David Turanski
- *
+ * @author John Blum
+ * @see java.lang.annotation.Annotation
+ * @see org.apache.geode.cache.execute.Execution
+ * @see org.apache.geode.cache.execute.Function
+ * @see org.springframework.data.gemfire.function.config.EnableGemfireFunctionExecutions
  */
 public class AnnotationFunctionExecutionConfigurationSource extends AbstractFunctionExecutionConfigurationSource {
 
@@ -50,28 +59,34 @@ public class AnnotationFunctionExecutionConfigurationSource extends AbstractFunc
 	private final AnnotationAttributes attributes;
 
 	/**
-	 * Creates a new instance of {@link AnnotationFunctionExecutionConfigurationSource} from
-	 * the given {@link AnnotationMetadata} and {@link EnableGemfireFunctionExecutions} annotation.
+	 * Constructs a new instance of {@link AnnotationFunctionExecutionConfigurationSource}
+	 * from the given {@link AnnotationMetadata} and {@link EnableGemfireFunctionExecutions} annotation.
 	 *
 	 * @param metadata {@link AnnotationMetadata} for the {@link EnableGemfireFunctionExecutions} annotation;
 	 * must not be {@literal null}.
 	 * @see org.springframework.core.type.AnnotationMetadata
 	 */
-	 public AnnotationFunctionExecutionConfigurationSource(AnnotationMetadata metadata) {
+	 public AnnotationFunctionExecutionConfigurationSource(@NonNull AnnotationMetadata metadata) {
 
 		Assert.notNull(metadata, "AnnotationMetadata must not be null");
 
-		this.attributes = AnnotationAttributes.fromMap(
-			metadata.getAnnotationAttributes(EnableGemfireFunctionExecutions.class.getName()));
+		this.attributes = AnnotationAttributes
+			.fromMap(metadata.getAnnotationAttributes(EnableGemfireFunctionExecutions.class.getName()));
 
 		this.metadata = metadata;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	@Override
 	public Object getSource() {
 		return this.metadata;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	@Override
 	public Iterable<String> getBasePackages() {
 
@@ -100,7 +115,7 @@ public Iterable<String> getBasePackages() {
 		return packages;
 	}
 
-	private boolean areAllEmpty(Object[]... arrays) {
+	private boolean areAllEmpty(@Nullable Object[]... arrays) {
 
 		for (Object[] array : ArrayUtils.nullSafeArray(arrays, Object[].class)) {
 			if (!ArrayUtils.isEmpty(array)) {
@@ -111,11 +126,17 @@ private boolean areAllEmpty(Object[]... arrays) {
 		return true;
 	}
 
+	/**
+	 * @inheritDoc
+	 */
 	@Override
 	public Iterable<TypeFilter> getIncludeFilters() {
 		return parseFilters("includeFilters");
 	}
 
+	/**
+	 * @inheritDoc
+	 */
  	@Override
 	public Iterable<TypeFilter> getExcludeFilters() {
 		return parseFilters("excludeFilters");

spring-data-geode/src/main/java/org/springframework/data/gemfire/function/config/FunctionExecutionBeanDefinitionParser.java

@@ -16,12 +16,12 @@
  */
 package org.springframework.data.gemfire.function.config;
 
-import org.w3c.dom.Element;
-
 import org.springframework.beans.factory.config.BeanDefinition;
 import org.springframework.beans.factory.xml.BeanDefinitionParser;
 import org.springframework.beans.factory.xml.ParserContext;
 
+import org.w3c.dom.Element;
+
 /**
  * Parser for a <function-executions> bean definition.
  *
@@ -34,6 +34,9 @@
  */
 public class FunctionExecutionBeanDefinitionParser implements BeanDefinitionParser {
 
+	/**
+	 * @inheritDoc
+	 */
 	@Override
 	public BeanDefinition parse(Element element, ParserContext parserContext) {
 		new FunctionExecutionBeanDefinitionRegistrar().registerBeanDefinitions(element, parserContext);

spring-data-geode/src/main/java/org/springframework/data/gemfire/function/config/FunctionExecutionBeanDefinitionRegistrar.java

@@ -51,6 +51,9 @@
  */
 public class FunctionExecutionBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
 
+	/**
+	 * @inheritDoc
+	 */
 	@Override
 	public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry registry) {
 

spring-data-geode/src/main/java/org/springframework/data/gemfire/function/config/FunctionExecutionComponentProvider.java

@@ -19,6 +19,9 @@
 import java.util.List;
 import java.util.Set;
 
+import org.apache.geode.cache.execute.Execution;
+import org.apache.geode.cache.execute.Function;
+
 import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
 import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider;
 import org.springframework.core.type.AnnotationMetadata;
@@ -27,6 +30,7 @@
 import org.springframework.core.type.filter.AbstractTypeHierarchyTraversingFilter;
 import org.springframework.core.type.filter.TypeFilter;
 import org.springframework.data.gemfire.util.CollectionUtils;
+import org.springframework.lang.NonNull;
 import org.springframework.util.Assert;
 
 /**
@@ -40,14 +44,16 @@ class FunctionExecutionComponentProvider extends ClassPathScanningCandidateCompo
 	private final Set<Class<? extends Annotation>> functionExecutionAnnotationTypes;
 
 	/**
-	 * Creates a new {@link FunctionExecutionComponentProvider} using the given {@link TypeFilter} to include components to be
-	 * picked up.
+	 * Constructs a new instance of {@link FunctionExecutionComponentProvider} using the given {@link TypeFilter}
+	 * to include components to be picked up during the scan.
 	 *
-	 * @param includeFilters the {@link TypeFilter}s to select function execution interfaces to consider, must not be
-	 *          {@literal null}.
+	 * @param includeFilters the {@link TypeFilter}s to select function execution interfaces to consider;
+	 * must not be {@literal null}.
+	 * @param functionExecutionAnnotationTypes {@link Set} of {@link Annotation} types denoting Apache Geode
+	 * {@link Function} {@link Execution Executions}.
 	 */
-	public FunctionExecutionComponentProvider(Iterable<? extends TypeFilter> includeFilters ,
-			Set<Class<? extends Annotation>> functionExecutionAnnotationTypes) {
+	public FunctionExecutionComponentProvider(@NonNull Iterable<? extends TypeFilter> includeFilters,
+			@NonNull Set<Class<? extends Annotation>> functionExecutionAnnotationTypes) {
 
 		super(false);
 
@@ -103,7 +109,6 @@ protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
 		return isTopLevelType;
 	}
 
-
 	// Copy of Spring's AnnotationTypeFilter until SPR-8336 gets resolved.
 
 	/**