You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by jb...@apache.org on 2018/08/20 17:00:11 UTC
[geode] branch develop updated: GEODE-5530: Cleanup javadoc
warnings from test refactoring.
This is an automated email from the ASF dual-hosted git repository.
jbarrett pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/geode.git
The following commit(s) were added to refs/heads/develop by this push:
new 20e059a GEODE-5530: Cleanup javadoc warnings from test refactoring.
20e059a is described below
commit 20e059a1712f1ff5746b42ee6298312e39f1dbfa
Author: Jacob Barrett <jb...@pivotal.io>
AuthorDate: Mon Aug 20 09:59:30 2018 -0700
GEODE-5530: Cleanup javadoc warnings from test refactoring.
---
.../web/controllers/NoArgumentFunction.java | 5 ++++
.../internal/web/controllers/RestTestUtils.java | 1 -
.../sockets/ClientServerMiscDUnitTestBase.java | 2 --
.../geode/test/junit/rules/GfshCommandRule.java | 2 +-
.../internal/cache/TestObjectWithIdentifier.java | 3 --
.../cache/extension/mock/MockCacheExtension.java | 2 +-
.../geode/test/junit/rules/ConcurrencyRule.java | 33 +++++++++++++---------
7 files changed, 26 insertions(+), 22 deletions(-)
diff --git a/geode-assembly/geode-assembly-test/src/main/java/org/apache/geode/rest/internal/web/controllers/NoArgumentFunction.java b/geode-assembly/geode-assembly-test/src/main/java/org/apache/geode/rest/internal/web/controllers/NoArgumentFunction.java
index 236995d..1e5fcff 100644
--- a/geode-assembly/geode-assembly-test/src/main/java/org/apache/geode/rest/internal/web/controllers/NoArgumentFunction.java
+++ b/geode-assembly/geode-assembly-test/src/main/java/org/apache/geode/rest/internal/web/controllers/NoArgumentFunction.java
@@ -18,8 +18,13 @@ package org.apache.geode.rest.internal.web.controllers;
import java.util.Set;
import org.apache.geode.cache.Region;
+import org.apache.geode.cache.execute.Execution;
import org.apache.geode.cache.execute.Function;
import org.apache.geode.cache.execute.FunctionContext;
+import org.apache.geode.cache.execute.FunctionException;
+import org.apache.geode.cache.execute.FunctionService;
+import org.apache.geode.cache.execute.RegionFunctionContext;
+import org.apache.geode.cache.execute.ResultCollector;
public class NoArgumentFunction implements Function {
/**
diff --git a/geode-assembly/geode-assembly-test/src/main/java/org/apache/geode/rest/internal/web/controllers/RestTestUtils.java b/geode-assembly/geode-assembly-test/src/main/java/org/apache/geode/rest/internal/web/controllers/RestTestUtils.java
index 7b03748..3755cb2 100644
--- a/geode-assembly/geode-assembly-test/src/main/java/org/apache/geode/rest/internal/web/controllers/RestTestUtils.java
+++ b/geode-assembly/geode-assembly-test/src/main/java/org/apache/geode/rest/internal/web/controllers/RestTestUtils.java
@@ -34,7 +34,6 @@ import org.springframework.web.util.UriComponentsBuilder;
* <p/>
*
* @see org.springframework.context.ApplicationContext
- * @see org.springframework.data.gemfire.GemfireTemplate
* @since GemFire 8.0
*/
public class RestTestUtils {
diff --git a/geode-dunit/src/main/java/org/apache/geode/internal/cache/tier/sockets/ClientServerMiscDUnitTestBase.java b/geode-dunit/src/main/java/org/apache/geode/internal/cache/tier/sockets/ClientServerMiscDUnitTestBase.java
index 3375c34..20d10ea 100755
--- a/geode-dunit/src/main/java/org/apache/geode/internal/cache/tier/sockets/ClientServerMiscDUnitTestBase.java
+++ b/geode-dunit/src/main/java/org/apache/geode/internal/cache/tier/sockets/ClientServerMiscDUnitTestBase.java
@@ -186,8 +186,6 @@ public class ClientServerMiscDUnitTestBase extends JUnit4CacheTestCase {
* When a client's subscription thread connects to a server it should receive the server's
* pingInterval setting. This is used by the client to set a read-timeout in order to avoid
* hanging should the server's machine crash.
- *
- * @see MessageJUnitTest#messageWillTimeoutDuringRecvOnInactiveSocket
*/
@Test
public void testClientReceivesPingIntervalSetting() {
diff --git a/geode-dunit/src/main/java/org/apache/geode/test/junit/rules/GfshCommandRule.java b/geode-dunit/src/main/java/org/apache/geode/test/junit/rules/GfshCommandRule.java
index f999cd7..b5838c9 100644
--- a/geode-dunit/src/main/java/org/apache/geode/test/junit/rules/GfshCommandRule.java
+++ b/geode-dunit/src/main/java/org/apache/geode/test/junit/rules/GfshCommandRule.java
@@ -67,7 +67,7 @@ import org.apache.geode.test.junit.assertions.CommandResultAssert;
* </pre>
*
* When using as a ClassRule, if you call connect in a test, you will need to call disconnect after
- * the test as well. See {@link org.apache.geode.management.internal.cli.NetstatDUnitTest} for
+ * the test as well. See org.apache.geode.management.internal.cli.NetstatDUnitTest for
* example.
*/
public class GfshCommandRule extends DescribedExternalResource {
diff --git a/geode-junit/src/main/java/org/apache/geode/internal/cache/TestObjectWithIdentifier.java b/geode-junit/src/main/java/org/apache/geode/internal/cache/TestObjectWithIdentifier.java
index 5b9aa91..8369861 100644
--- a/geode-junit/src/main/java/org/apache/geode/internal/cache/TestObjectWithIdentifier.java
+++ b/geode-junit/src/main/java/org/apache/geode/internal/cache/TestObjectWithIdentifier.java
@@ -28,9 +28,6 @@ import org.apache.geode.internal.size.Sizeable;
/**
* Object used for the put() operation as key and object. The objectIdentifier is used to provide a
* predetermined hashcode for the object.
- *
- * <p>
- * Extracted from {@link PartitionedRegionLocalMaxMemoryDUnitTest}.
*/
public class TestObjectWithIdentifier implements DataSerializable, Sizeable {
diff --git a/geode-junit/src/main/java/org/apache/geode/internal/cache/extension/mock/MockCacheExtension.java b/geode-junit/src/main/java/org/apache/geode/internal/cache/extension/mock/MockCacheExtension.java
index e5f728b..04841fb 100644
--- a/geode-junit/src/main/java/org/apache/geode/internal/cache/extension/mock/MockCacheExtension.java
+++ b/geode-junit/src/main/java/org/apache/geode/internal/cache/extension/mock/MockCacheExtension.java
@@ -25,7 +25,7 @@ import org.apache.geode.internal.cache.xmlcache.XmlGenerator;
* <dl>
* <dt>Uses</dt>
* <dd>org.apache.geode.management.internal.configuration.ClusterConfigurationDUnitTest</dd>
- * <dd>{@link org.apache.geode.cache30.CacheXml81DUnitTest}</dd>
+ * <dd>org.apache.geode.cache30.CacheXml81DUnitTest</dd>
* </dl>
*
*
diff --git a/geode-junit/src/main/java/org/apache/geode/test/junit/rules/ConcurrencyRule.java b/geode-junit/src/main/java/org/apache/geode/test/junit/rules/ConcurrencyRule.java
index 948b2d4..b45c8e2 100644
--- a/geode-junit/src/main/java/org/apache/geode/test/junit/rules/ConcurrencyRule.java
+++ b/geode-junit/src/main/java/org/apache/geode/test/junit/rules/ConcurrencyRule.java
@@ -51,21 +51,26 @@ import org.apache.geode.test.junit.rules.serializable.SerializableExternalResour
*
* Example Usage:
*
- * @Rule
- * public ConcurrencyRule concurrencyRule = new ConcurrencyRule(); // step 1
+ * <pre>
+ * <code>
*
- * @Test
- * public void testName() {
- * Callable<String> c1 = () -> {
- * return "some Value";
- * }; // step 2
+ * {@literal @}Rule
+ * public ConcurrencyRule concurrencyRule = new ConcurrencyRule(); // step 1
*
- * concurrencyRule.add(c1).expectValue("some Value").repeatForIterations(3); // steps 3&4
- * concurrencyRule.executeInParallel(); // step 5
- * concurrencyRule.clear(); // step 6
- * // keep using the rule as above, or ConcurrencyRule.after() will be called for cleanup
- * }
+ * {@literal @}Test
+ * public void testName() {
+ * Callable<String> c1 = () -> {
+ * return "some Value";
+ * }; // step 2
*
+ * concurrencyRule.add(c1).expectValue("some Value").repeatForIterations(3); // steps 3&4
+ * concurrencyRule.executeInParallel(); // step 5
+ * concurrencyRule.clear(); // step 6
+ * // keep using the rule as above, or ConcurrencyRule.after() will be called for cleanup
+ * }
+ *
+ * </code>
+ * </pre>
*/
public class ConcurrencyRule extends SerializableExternalResource {
@@ -110,7 +115,7 @@ public class ConcurrencyRule extends SerializableExternalResource {
* Adds a Callable to the concurrency rule to be run. Expectations for return values and thrown
* exceptions, as well as any repetition of the thread should be added using ConcurrentOperation.
*
- * @param callable, a Callable to be run. If the Callable throws an exception that is not expected
+ * @param callable a Callable to be run. If the Callable throws an exception that is not expected
* it will be thrown up to the test that the threads are run from.
* @return concurrentOperation, the ConcurrentOperation that has been added to the rule
*/
@@ -285,7 +290,7 @@ public class ConcurrencyRule extends SerializableExternalResource {
* callable will not be restarted after the duration has been met, however the current
* iteration will be allowed to continue until the timeout is reached.
*
- * @param duration, the Duration for which to repeat the callable
+ * @param duration the Duration for which to repeat the callable
* @return this, the ConcurrentOperation (containing a callable) that has been set to repeat
*/
public ConcurrentOperation repeatForDuration(Duration duration) {