From efc645b3a71af7b49a60182ac6e34370b038f50c Mon Sep 17 00:00:00 2001 From: John Blum Date: Wed, 23 May 2018 18:51:17 -0700 Subject: [PATCH] Fix Javadoc. --- .../GemFireRepositoriesAutoConfigurationRegistrar.java | 1 - .../function/execution/AbstractResultCollector.java | 4 +++- .../function/execution/SingleResultReturningCollector.java | 7 ++++++- .../boot/data/geode/function/executions/Calculator.java | 4 ++-- 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/geode-spring-boot-starter/src/main/java/org/springframework/boot/data/geode/autoconfigure/GemFireRepositoriesAutoConfigurationRegistrar.java b/geode-spring-boot-starter/src/main/java/org/springframework/boot/data/geode/autoconfigure/GemFireRepositoriesAutoConfigurationRegistrar.java index c3450448..e44d59d1 100644 --- a/geode-spring-boot-starter/src/main/java/org/springframework/boot/data/geode/autoconfigure/GemFireRepositoriesAutoConfigurationRegistrar.java +++ b/geode-spring-boot-starter/src/main/java/org/springframework/boot/data/geode/autoconfigure/GemFireRepositoriesAutoConfigurationRegistrar.java @@ -30,7 +30,6 @@ import org.springframework.data.repository.config.RepositoryConfigurationExtensi * @author John Blum * @see org.springframework.boot.autoconfigure.data.AbstractRepositoryConfigurationSourceSupport * @see org.springframework.boot.data.geode.autoconfigure.RepositoriesAutoConfiguration - * @see EnableGemFireRepositoriesConfiguration * @see org.springframework.data.gemfire.repository.config.EnableGemfireRepositories * @see org.springframework.data.gemfire.repository.config.GemfireRepositoryConfigurationExtension * @since 1.0.0 diff --git a/geode-spring-boot-starter/src/main/java/org/springframework/data/gemfire/function/execution/AbstractResultCollector.java b/geode-spring-boot-starter/src/main/java/org/springframework/data/gemfire/function/execution/AbstractResultCollector.java index f7cf6d84..263251aa 100644 --- a/geode-spring-boot-starter/src/main/java/org/springframework/data/gemfire/function/execution/AbstractResultCollector.java +++ b/geode-spring-boot-starter/src/main/java/org/springframework/data/gemfire/function/execution/AbstractResultCollector.java @@ -23,9 +23,11 @@ import org.apache.geode.cache.execute.FunctionException; import org.apache.geode.cache.execute.ResultCollector; /** - * The AbstractResultCollector class... + * The {@link AbstractResultCollector} class is an abstract base implementation of the {@link ResultCollector} interface + * encapsulating common functionality for collecting results from a Function execution. * * @author John Blum + * @see org.apache.geode.cache.execute.ResultCollector * @since 1.0.0 */ @SuppressWarnings("unused") diff --git a/geode-spring-boot-starter/src/main/java/org/springframework/data/gemfire/function/execution/SingleResultReturningCollector.java b/geode-spring-boot-starter/src/main/java/org/springframework/data/gemfire/function/execution/SingleResultReturningCollector.java index e5ea232d..bbbe4f89 100644 --- a/geode-spring-boot-starter/src/main/java/org/springframework/data/gemfire/function/execution/SingleResultReturningCollector.java +++ b/geode-spring-boot-starter/src/main/java/org/springframework/data/gemfire/function/execution/SingleResultReturningCollector.java @@ -20,14 +20,19 @@ import java.util.Collections; import java.util.Iterator; import java.util.Optional; +import org.apache.geode.cache.execute.ResultCollector; import org.apache.geode.distributed.DistributedMember; /** - * The SingleResultReturningCollector class... + * The {@link SingleResultReturningCollector} class is an implementation of the {@link ResultCollector} interface + * which returns a single {@link Object result}. * * @author John Blum + * @see org.apache.geode.cache.execute.ResultCollector + * @see org.springframework.data.gemfire.function.execution.AbstractResultCollector * @since 1.0.0 */ +@SuppressWarnings("unused") public class SingleResultReturningCollector extends AbstractResultCollector { @Override diff --git a/geode-spring-boot-starter/src/test/java/org/springframework/boot/data/geode/function/executions/Calculator.java b/geode-spring-boot-starter/src/test/java/org/springframework/boot/data/geode/function/executions/Calculator.java index 701632de..1d79d196 100644 --- a/geode-spring-boot-starter/src/test/java/org/springframework/boot/data/geode/function/executions/Calculator.java +++ b/geode-spring-boot-starter/src/test/java/org/springframework/boot/data/geode/function/executions/Calculator.java @@ -16,13 +16,13 @@ package org.springframework.boot.data.geode.function.executions; -import org.junit.experimental.theories.suppliers.TestedOn; import org.springframework.data.gemfire.function.annotation.OnRegion; /** - * The Calculator class... + * The {@link Calculator} interface defines Apache Geode/Pivotal GemFire Functions. * * @author John Blum + * @see org.springframework.data.gemfire.function.annotation.OnRegion * @since 1.0.0 */ @SuppressWarnings("all")