From 92be8ef208b503c6987d811b2046a1625bac63db Mon Sep 17 00:00:00 2001 From: John Blum Date: Thu, 22 Mar 2018 10:32:03 -0700 Subject: [PATCH] Set all @since Javadoc tags to 0.0.1. --- .../tests/mock/MockGemFireObjectsSupport.java | 2 +- .../tests/mock/MockObjectsSupport.java | 2 +- .../annotation/EnableGemFireMockObjects.java | 2 +- .../GemFireMockObjectsConfiguration.java | 2 +- .../mock/annotation/GemFireUnitTest.java | 2 +- .../MockGemFireObjectsBeanPostProcessor.java | 2 +- ...eObjectsApplicationContextInitializer.java | 2 +- .../MockObjectInvocationException.java | 4 ++-- .../mock/support/MockObjectsException.java | 2 +- .../tests/support/DataSourceAdapter.java | 9 +++---- .../tests/support/IdentifierSequence.java | 9 ++++--- .../gemfire/tests/support/MapBuilder.java | 2 +- .../gemfire/tests/util/FileSystemUtils.java | 24 +++++++++---------- .../data/gemfire/tests/util/FileUtils.java | 2 +- .../data/gemfire/tests/util/IOUtils.java | 2 +- .../gemfire/tests/util/StackTraceUtils.java | 2 +- .../data/gemfire/tests/util/ThreadUtils.java | 2 +- .../gemfire/tests/util/ThrowableUtils.java | 2 +- .../data/gemfire/tests/util/ZipUtils.java | 2 +- 19 files changed, 37 insertions(+), 39 deletions(-) diff --git a/src/main/java/org/springframework/data/gemfire/tests/mock/MockGemFireObjectsSupport.java b/src/main/java/org/springframework/data/gemfire/tests/mock/MockGemFireObjectsSupport.java index dba6332..edb29f7 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/mock/MockGemFireObjectsSupport.java +++ b/src/main/java/org/springframework/data/gemfire/tests/mock/MockGemFireObjectsSupport.java @@ -140,7 +140,7 @@ import org.springframework.data.gemfire.tests.util.FileSystemUtils; * @see org.apache.geode.distributed.DistributedSystem * @see org.mockito.Mockito * @see org.springframework.data.gemfire.tests.mock.MockObjectsSupport - * @since 2.0.0 + * @since 0.0.1 */ @SuppressWarnings("unused") public abstract class MockGemFireObjectsSupport extends MockObjectsSupport { diff --git a/src/main/java/org/springframework/data/gemfire/tests/mock/MockObjectsSupport.java b/src/main/java/org/springframework/data/gemfire/tests/mock/MockObjectsSupport.java index 6436050..86bab5c 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/mock/MockObjectsSupport.java +++ b/src/main/java/org/springframework/data/gemfire/tests/mock/MockObjectsSupport.java @@ -38,7 +38,7 @@ import org.springframework.util.StringUtils; * @author John Blum * @see org.mockito.invocation.InvocationOnMock * @see org.mockito.stubbing.Answer - * @since 2.0.0 + * @since 0.0.1 */ @SuppressWarnings("unused") public abstract class MockObjectsSupport { diff --git a/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/EnableGemFireMockObjects.java b/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/EnableGemFireMockObjects.java index 28f3c14..6756e47 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/EnableGemFireMockObjects.java +++ b/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/EnableGemFireMockObjects.java @@ -36,7 +36,7 @@ import org.springframework.context.annotation.Import; * @see Target * @see org.apache.geode.cache.GemFireCache * @see org.springframework.context.annotation.Import - * @since 2.0.0 + * @since 0.0.1 */ @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfiguration.java b/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfiguration.java index 46e39f0..f434fd1 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfiguration.java +++ b/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireMockObjectsConfiguration.java @@ -42,7 +42,7 @@ import org.springframework.data.gemfire.tests.mock.config.MockGemFireObjectsBean * @see org.springframework.core.annotation.AnnotationAttributes * @see org.springframework.core.type.AnnotationMetadata * @see org.springframework.data.gemfire.test.mock.config.MockGemFireObjectsBeanPostProcessor - * @since 2.0.0 + * @since 0.0.1 */ @SuppressWarnings("unused") @Configuration diff --git a/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireUnitTest.java b/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireUnitTest.java index 2526513..6694e88 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireUnitTest.java +++ b/src/main/java/org/springframework/data/gemfire/tests/mock/annotation/GemFireUnitTest.java @@ -44,7 +44,7 @@ import org.springframework.test.context.junit4.SpringRunner; * @see org.springframework.data.gemfire.test.mock.context.MockGemFireObjectsApplicationContextInitializer * @see org.springframework.test.context.ContextConfiguration * @see org.springframework.test.context.junit4.SpringRunner - * @since 2.0.0 + * @since 0.0.1 */ @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/java/org/springframework/data/gemfire/tests/mock/config/MockGemFireObjectsBeanPostProcessor.java b/src/main/java/org/springframework/data/gemfire/tests/mock/config/MockGemFireObjectsBeanPostProcessor.java index 007b1f9..70088d8 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/mock/config/MockGemFireObjectsBeanPostProcessor.java +++ b/src/main/java/org/springframework/data/gemfire/tests/mock/config/MockGemFireObjectsBeanPostProcessor.java @@ -47,7 +47,7 @@ import org.springframework.lang.Nullable; * @see org.springframework.data.gemfire.client.ClientCacheFactoryBean * @see org.springframework.data.gemfire.client.PoolFactoryBean * @see org.springframework.data.gemfire.tests.mock.MockGemFireObjectsSupport - * @since 2.0.0 + * @since 0.0.1 */ public class MockGemFireObjectsBeanPostProcessor implements BeanPostProcessor { diff --git a/src/main/java/org/springframework/data/gemfire/tests/mock/context/MockGemFireObjectsApplicationContextInitializer.java b/src/main/java/org/springframework/data/gemfire/tests/mock/context/MockGemFireObjectsApplicationContextInitializer.java index aefb594..7f3b241 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/mock/context/MockGemFireObjectsApplicationContextInitializer.java +++ b/src/main/java/org/springframework/data/gemfire/tests/mock/context/MockGemFireObjectsApplicationContextInitializer.java @@ -28,7 +28,7 @@ import org.springframework.data.gemfire.tests.mock.config.MockGemFireObjectsBean * @see org.springframework.context.ApplicationContextInitializer * @see org.springframework.context.ConfigurableApplicationContext * @see org.springframework.data.gemfire.test.mock.config.MockGemFireObjectsBeanPostProcessor - * @since 2.0.0 + * @since 0.0.1 */ public class MockGemFireObjectsApplicationContextInitializer implements ApplicationContextInitializer { diff --git a/src/main/java/org/springframework/data/gemfire/tests/mock/support/MockObjectInvocationException.java b/src/main/java/org/springframework/data/gemfire/tests/mock/support/MockObjectInvocationException.java index a7e4e71..3ba8386 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/mock/support/MockObjectInvocationException.java +++ b/src/main/java/org/springframework/data/gemfire/tests/mock/support/MockObjectInvocationException.java @@ -23,8 +23,8 @@ import java.lang.reflect.Method; * problems with {@link Method method} invocations on {@link Object Mock Objects}. * * @author John Blum - * @see org.springframework.data.gemfire.test.mock.support.MockObjectsException - * @since 2.0.1 + * @see org.springframework.data.gemfire.tests.mock.support.MockObjectsException + * @since 0.0.1 */ @SuppressWarnings("unused") public class MockObjectInvocationException extends MockObjectsException { diff --git a/src/main/java/org/springframework/data/gemfire/tests/mock/support/MockObjectsException.java b/src/main/java/org/springframework/data/gemfire/tests/mock/support/MockObjectsException.java index 721ad53..330a50a 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/mock/support/MockObjectsException.java +++ b/src/main/java/org/springframework/data/gemfire/tests/mock/support/MockObjectsException.java @@ -22,7 +22,7 @@ package org.springframework.data.gemfire.tests.mock.support; * * @author John Blum * @see RuntimeException - * @since 2.0.1 + * @since 0.0.1 */ @SuppressWarnings("unused") public class MockObjectsException extends RuntimeException { diff --git a/src/main/java/org/springframework/data/gemfire/tests/support/DataSourceAdapter.java b/src/main/java/org/springframework/data/gemfire/tests/support/DataSourceAdapter.java index 24b5bde..d0128f4 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/support/DataSourceAdapter.java +++ b/src/main/java/org/springframework/data/gemfire/tests/support/DataSourceAdapter.java @@ -25,12 +25,13 @@ import java.util.logging.Logger; import javax.sql.DataSource; /** - * The DataSourceAdapter class is an implementation of the DataSource interface with unsupported operations by default. + * The {@link DataSourceAdapter} class is an implementation of the {@link DataSource} interface + * with unsupported operations by default. * * @author John Blum - * @see Connection - * @see DataSource - * @since 1.3.4 + * @see java.sql.Connection + * @see javax.sql.DataSource + * @since 0.0.1 */ @SuppressWarnings("unused") public abstract class DataSourceAdapter implements DataSource { diff --git a/src/main/java/org/springframework/data/gemfire/tests/support/IdentifierSequence.java b/src/main/java/org/springframework/data/gemfire/tests/support/IdentifierSequence.java index b5f663b..2b17406 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/support/IdentifierSequence.java +++ b/src/main/java/org/springframework/data/gemfire/tests/support/IdentifierSequence.java @@ -19,12 +19,12 @@ package org.springframework.data.gemfire.tests.support; import java.util.concurrent.atomic.AtomicLong; /** - * The IdentifierSequence class is an Identifier (ID) generator generating unique IDs in sequence. + * The {@link IdentifierSequence} class is an Identifier (ID) generator generating unique IDs in sequence. * * @author John Blum - * @see System#currentTimeMillis() - * @see AtomicLong - * @since 1.5.3 + * @see java.lang.System#currentTimeMillis() + * @see java.util.concurrent.atomic.AtomicLong + * @since 0.0.1 */ @SuppressWarnings("unused") public abstract class IdentifierSequence { @@ -34,5 +34,4 @@ public abstract class IdentifierSequence { public static long nextId() { return ID_SEQUENCE.incrementAndGet(); } - } diff --git a/src/main/java/org/springframework/data/gemfire/tests/support/MapBuilder.java b/src/main/java/org/springframework/data/gemfire/tests/support/MapBuilder.java index 9d7e788..3cffdb5 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/support/MapBuilder.java +++ b/src/main/java/org/springframework/data/gemfire/tests/support/MapBuilder.java @@ -24,7 +24,7 @@ import java.util.Map; * * @author John Blum * @see Map - * @since 2.0.0 + * @since 0.0.1 */ public class MapBuilder { diff --git a/src/main/java/org/springframework/data/gemfire/tests/util/FileSystemUtils.java b/src/main/java/org/springframework/data/gemfire/tests/util/FileSystemUtils.java index 8eda49a..41439a6 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/util/FileSystemUtils.java +++ b/src/main/java/org/springframework/data/gemfire/tests/util/FileSystemUtils.java @@ -32,11 +32,11 @@ import org.springframework.util.Assert; * file system directories and files collectively. * * @author John Blum - * @see File - * @see FileFilter - * @see org.springframework.data.gemfire.test.support.FileUtils - * @see org.springframework.data.gemfire.test.support.IOUtils - * @since 1.5.0 + * @see java.io.File + * @see java.io.FileFilter + * @see org.springframework.data.gemfire.tests.util.FileUtils + * @see org.springframework.data.gemfire.tests.util.IOUtils + * @since 0.0.1 */ @SuppressWarnings("unused") public abstract class FileSystemUtils extends FileUtils { @@ -49,13 +49,12 @@ public abstract class FileSystemUtils extends FileUtils { public static final File[] NO_FILES = new File[0]; - /* (non-Javadoc) */ public static boolean deleteRecursive(File path) { return deleteRecursive(path, AllFilesFilter.INSTANCE); } - /* (non-Javadoc) */ public static boolean deleteRecursive(File path, FileFilter fileFilter) { + boolean success = true; if (isDirectory(path)) { @@ -68,11 +67,12 @@ public abstract class FileSystemUtils extends FileUtils { } public static boolean exists(File path) { - return (path != null && path.exists()); + return path != null && path.exists(); } // returns sub-directory just below working directory public static File getRootRelativeToWorkingDirectoryOrPath(File path) { + File localPath = path; if (isDirectory(localPath)) { @@ -84,10 +84,10 @@ public abstract class FileSystemUtils extends FileUtils { return (localPath != null ? localPath : path); } - /* (non-Javadoc) */ public static File[] listFiles(File directory, FileFilter fileFilter) { - Assert.isTrue(isDirectory(directory), String.format( - "File [%s] does not refer to a valid directory", directory)); + + Assert.isTrue(isDirectory(directory), + String.format("File [%s] does not refer to a valid directory", directory)); List results = new ArrayList(); @@ -103,12 +103,10 @@ public abstract class FileSystemUtils extends FileUtils { return results.toArray(new File[results.size()]); } - /* (non-Javadoc) */ public static File[] safeListFiles(File directory) { return safeListFiles(directory, AllFilesFilter.INSTANCE); } - /* (non-Javadoc) */ public static File[] safeListFiles(File directory, FileFilter fileFilter) { FileFilter resolvedFileFilter = (fileFilter != null ? fileFilter : AllFilesFilter.INSTANCE); File[] files = (isDirectory(directory) ? directory.listFiles(resolvedFileFilter) : null); diff --git a/src/main/java/org/springframework/data/gemfire/tests/util/FileUtils.java b/src/main/java/org/springframework/data/gemfire/tests/util/FileUtils.java index ac26478..72e9c85 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/util/FileUtils.java +++ b/src/main/java/org/springframework/data/gemfire/tests/util/FileUtils.java @@ -35,7 +35,7 @@ import org.springframework.util.StringUtils; * @see FileReader * @see FileWriter * @see org.springframework.data.gemfire.test.support.IOUtils - * @since 1.5.0 + * @since 0.0.1 */ @SuppressWarnings("unused") public abstract class FileUtils extends IOUtils { diff --git a/src/main/java/org/springframework/data/gemfire/tests/util/IOUtils.java b/src/main/java/org/springframework/data/gemfire/tests/util/IOUtils.java index 5f842c2..d095a25 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/util/IOUtils.java +++ b/src/main/java/org/springframework/data/gemfire/tests/util/IOUtils.java @@ -31,7 +31,7 @@ import java.util.logging.Logger; * * @author John Blum * @see Closeable - * @since 1.5.0 + * @since 0.0.1 */ @SuppressWarnings("unused") public abstract class IOUtils { diff --git a/src/main/java/org/springframework/data/gemfire/tests/util/StackTraceUtils.java b/src/main/java/org/springframework/data/gemfire/tests/util/StackTraceUtils.java index bdca7bd..727bace 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/util/StackTraceUtils.java +++ b/src/main/java/org/springframework/data/gemfire/tests/util/StackTraceUtils.java @@ -23,7 +23,7 @@ package org.springframework.data.gemfire.tests.util; * @see StackTraceElement * @see Thread * @see org.springframework.data.gemfire.test.support.ThreadUtils - * @since 1.5.3 + * @since 0.0.1 */ @SuppressWarnings("unused") public abstract class StackTraceUtils extends ThreadUtils { diff --git a/src/main/java/org/springframework/data/gemfire/tests/util/ThreadUtils.java b/src/main/java/org/springframework/data/gemfire/tests/util/ThreadUtils.java index 61bedeb..de95fe8 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/util/ThreadUtils.java +++ b/src/main/java/org/springframework/data/gemfire/tests/util/ThreadUtils.java @@ -23,7 +23,7 @@ import java.util.concurrent.TimeUnit; * * @author John Blum * @see Thread - * @since 1.5.0 + * @since 0.0.1 */ @SuppressWarnings("unused") public abstract class ThreadUtils { diff --git a/src/main/java/org/springframework/data/gemfire/tests/util/ThrowableUtils.java b/src/main/java/org/springframework/data/gemfire/tests/util/ThrowableUtils.java index 164d125..2135bde 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/util/ThrowableUtils.java +++ b/src/main/java/org/springframework/data/gemfire/tests/util/ThrowableUtils.java @@ -26,7 +26,7 @@ import java.io.StringWriter; * @see Error * @see Exception * @see Throwable - * @since 1.5.0 + * @since 0.0.1 */ @SuppressWarnings("unused") public abstract class ThrowableUtils { diff --git a/src/main/java/org/springframework/data/gemfire/tests/util/ZipUtils.java b/src/main/java/org/springframework/data/gemfire/tests/util/ZipUtils.java index 285747d..6fea094 100644 --- a/src/main/java/org/springframework/data/gemfire/tests/util/ZipUtils.java +++ b/src/main/java/org/springframework/data/gemfire/tests/util/ZipUtils.java @@ -35,7 +35,7 @@ import org.springframework.util.FileCopyUtils; * @author John Blum * @see File * @see ZipFile - * @since 1.5.0 + * @since 0.0.1 */ public abstract class ZipUtils {