This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-jcs.git
The following commit(s) were added to refs/heads/master by this push:
new bf86d53d Normalize setter Javadoc
bf86d53d is described below
commit bf86d53d6cdfd0eff455816c5b2edcac243bfdfa
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 07:08:39 2023 -0400
Normalize setter Javadoc
---
.../src/main/java/org/apache/commons/jcs3/JCS.java | 6 +++---
.../commons/jcs3/auxiliary/disk/block/BlockDiskKeyStore.java | 2 +-
.../commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java | 2 +-
.../apache/commons/jcs3/auxiliary/remote/RemoteCache.java | 2 +-
.../auxiliary/remote/behavior/IRemoteCacheAttributes.java | 2 +-
.../jcs3/auxiliary/remote/behavior/IRemoteCacheListener.java | 2 +-
.../auxiliary/remote/server/RemoteCacheStartupServlet.java | 2 +-
.../commons/jcs3/engine/ZombieCacheServiceNonLocal.java | 4 ++--
.../org/apache/commons/jcs3/engine/stats/StatElement.java | 2 +-
.../commons/jcs3/engine/stats/behavior/IStatElement.java | 2 +-
.../apache/commons/jcs3/engine/stats/behavior/IStats.java | 4 ++--
.../main/java/org/apache/commons/jcs3/log/LogManager.java | 2 +-
.../org/apache/commons/jcs3/utils/config/PropertySetter.java | 8 ++++----
.../jcs3/utils/serialization/EncryptingSerializer.java | 4 ++--
.../disk/indexed/IndexedDiskCacheOptimizationUnitTest.java | 2 +-
.../commons/jcs3/auxiliary/disk/jdbc/HsqlSetupUtil.java | 2 +-
.../jcs3/auxiliary/remote/MockRemoteCacheService.java | 12 ++++++------
.../apache/commons/jcs3/engine/MockCacheServiceNonLocal.java | 12 ++++++------
.../utils/discovery/UDPDiscoverySenderEncryptedUnitTest.java | 2 +-
.../jcs3/utils/discovery/UDPDiscoverySenderUnitTest.java | 2 +-
20 files changed, 38 insertions(+), 38 deletions(-)
diff --git a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/JCS.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/JCS.java
index b9484880..2543e661 100644
--- a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/JCS.java
+++ b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/JCS.java
@@ -50,7 +50,7 @@ public abstract class JCS
private static CompositeCacheManager cacheMgr;
/**
- * Set the file name that the cache manager will be initialized with. Only
matters before the
+ * Sets the file name that the cache manager will be initialized with.
Only matters before the
* instance is initialized.
*
* @param configFileName
@@ -61,7 +61,7 @@ public abstract class JCS
}
/**
- * Set the properties that the cache manager will be initialized with. Only
+ * Sets the properties that the cache manager will be initialized with.
Only
* matters before the instance is initialized.
*
* @param configProps
@@ -72,7 +72,7 @@ public abstract class JCS
}
/**
- * Set the log system. Must be called before getInstance is called
+ * Sets the log system. Must be called before getInstance is called
* Predefined Log systems are {@link
LogManager#LOGSYSTEM_JAVA_UTIL_LOGGING}
* and {@link LogManager#LOGSYSTEM_LOG4J2}
*
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskKeyStore.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskKeyStore.java
index 8a012ece..cb2c7f23 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskKeyStore.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/block/BlockDiskKeyStore.java
@@ -249,7 +249,7 @@ public class BlockDiskKeyStore<K>
private final IElementSerializer serializer;
/**
- * Set the configuration options.
+ * Sets the configuration options.
* <p>
*
* @param cacheAttributes
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java
index c4ddba47..67dfd053 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/LateralCacheNoWait.java
@@ -118,7 +118,7 @@ public class LateralCacheNoWait<K, V>
}
/**
- * Set the identifying key to this no wait
+ * Sets the identifying key to this no wait
*
* @param identityKey the identityKey to set
* @since 3.1
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCache.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCache.java
index 3453e94d..4deb201a 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCache.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteCache.java
@@ -103,7 +103,7 @@ public class RemoteCache<K, V>
}
/**
- * Set facade
+ * Sets facade
*
* @param facade the facade to set
*/
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheAttributes.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheAttributes.java
index 494c630f..26b0d779 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheAttributes.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheAttributes.java
@@ -114,7 +114,7 @@ public interface IRemoteCacheAttributes
String getThreadPoolName();
/**
- * Set the name of the pool to use. Pools should be defined in the
cache.ccf.
+ * Sets the name of the pool to use. Pools should be defined in the
cache.ccf.
* <p>
* @param name
*/
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheListener.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheListener.java
index 41721255..a2783d44 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheListener.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/behavior/IRemoteCacheListener.java
@@ -42,7 +42,7 @@ public interface IRemoteCacheListener<K, V>
throws IOException;
/**
- * Set the id to be used by this manager. The remote cache server
identifies clients by this id.
+ * Sets the id to be used by this manager. The remote cache server
identifies clients by this id.
* The value will be set by the server through the remote cache listener.
* <p>
* @param id
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheStartupServlet.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheStartupServlet.java
index 816dc7c2..6840104f 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheStartupServlet.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheStartupServlet.java
@@ -267,7 +267,7 @@ public class RemoteCacheStartupServlet
}
/**
- * Set registry port from string If the string cannot be parsed, the
default
+ * Sets registry port from string If the string cannot be parsed, the
default
* value is used
*
* @param portS
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/ZombieCacheServiceNonLocal.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/ZombieCacheServiceNonLocal.java
index 3ef39ccd..242bec23 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/ZombieCacheServiceNonLocal.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/ZombieCacheServiceNonLocal.java
@@ -265,7 +265,7 @@ public class ZombieCacheServiceNonLocal<K, V>
final ICacheElement<K, V> element;
/**
- * Set the element
+ * Sets the element
* @param element
* @param requesterId
*/
@@ -286,7 +286,7 @@ public class ZombieCacheServiceNonLocal<K, V>
final K key;
/**
- * Set the element
+ * Sets the element
* @param cacheName
* @param key
* @param requesterId
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/StatElement.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/StatElement.java
index a26c88a7..7f88c72c 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/StatElement.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/StatElement.java
@@ -80,7 +80,7 @@ public class StatElement<V>
}
/**
- * Set the data for this element.
+ * Sets the data for this element.
* <p>
* @param data
*/
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/behavior/IStatElement.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/behavior/IStatElement.java
index a9f4b6df..e920d83d 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/behavior/IStatElement.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/behavior/IStatElement.java
@@ -46,7 +46,7 @@ public interface IStatElement<V> extends Serializable
V getData();
/**
- * Set the data for this element.
+ * Sets the data for this element.
* <p>
* @param data
*/
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/behavior/IStats.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/behavior/IStats.java
index a11a2943..1701aaf0 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/behavior/IStats.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/behavior/IStats.java
@@ -37,7 +37,7 @@ public interface IStats
List<IStatElement<?>> getStatElements();
/**
- * Set the generic statistical or historical data.
+ * Sets the generic statistical or historical data.
*
* @param stats
*/
@@ -51,7 +51,7 @@ public interface IStats
String getTypeName();
/**
- * Set the type name, such as "LRU Memory Cache." No formal type is
defined.
+ * Sets the type name, such as "LRU Memory Cache." No formal type is
defined.
* If we need formal types, we can use the cachetype param
*
* @param name
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/log/LogManager.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/log/LogManager.java
index 7abaec39..3d88f9d6 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/log/LogManager.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/log/LogManager.java
@@ -104,7 +104,7 @@ public class LogManager
}
/**
- * Set the log system. Must be called before getLog is called
+ * Sets the log system. Must be called before getLog is called
*
* @param logSystem the logSystem to set
*/
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/config/PropertySetter.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/config/PropertySetter.java
index a06578e5..b8a5b65a 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/config/PropertySetter.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/config/PropertySetter.java
@@ -90,7 +90,7 @@ public class PropertySetter
}
/**
- * Set the properties of an object passed as a parameter in one go. The
<code>properties</code>
+ * Sets the properties of an object passed as a parameter in one go. The
<code>properties</code>
* are parsed relative to a <code>prefix</code>.
* <p>
* @param obj The object to configure.
@@ -103,7 +103,7 @@ public class PropertySetter
}
/**
- * Set the properties for the object that match the <code>prefix</code>
passed as parameter.
+ * Sets the properties for the object that match the <code>prefix</code>
passed as parameter.
* <p>
* @param properties The new properties value
* @param prefix The new properties value
@@ -134,7 +134,7 @@ public class PropertySetter
}
/**
- * Set a property on this PropertySetter's Object. If successful, this
method will invoke a
+ * Sets a property on this PropertySetter's Object. If successful, this
method will invoke a
* setter method on the underlying Object. The setter is the one for the
specified property name
* and the value is determined partly from the setter argument type and
partly from the value
* specified in the call to this method.
@@ -176,7 +176,7 @@ public class PropertySetter
}
/**
- * Set the named property given a {@link PropertyDescriptor}.
+ * Sets the named property given a {@link PropertyDescriptor}.
* @param prop A PropertyDescriptor describing the characteristics of the
property to set.
* @param name The named of the property to set.
* @param value The value of the property.
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/serialization/EncryptingSerializer.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/serialization/EncryptingSerializer.java
index 1efed5f8..deaa5dfa 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/serialization/EncryptingSerializer.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/serialization/EncryptingSerializer.java
@@ -100,7 +100,7 @@ public class EncryptingSerializer extends StandardSerializer
}
/**
- * Set the pre-shared key for encryption and decryption
+ * Sets the pre-shared key for encryption and decryption
*
* @param psk the key
*/
@@ -110,7 +110,7 @@ public class EncryptingSerializer extends StandardSerializer
}
/**
- * Set the cipher transformation for encryption and decryption
+ * Sets the cipher transformation for encryption and decryption
* Default is AES/ECB/PKCS5Padding
*
* @param transformation the transformation
diff --git
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCacheOptimizationUnitTest.java
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCacheOptimizationUnitTest.java
index a61a2e20..55942394 100644
---
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCacheOptimizationUnitTest.java
+++
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/indexed/IndexedDiskCacheOptimizationUnitTest.java
@@ -33,7 +33,7 @@ import org.junit.Test;
public class IndexedDiskCacheOptimizationUnitTest
{
/**
- * Set the optimize at remove count to 10. Add 20. Check the file size.
Remove 10. Check the
+ * Sets the optimize at remove count to 10. Add 20. Check the file size.
Remove 10. Check the
* times optimized. Check the file size.
* @throws Exception
*/
diff --git
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/HsqlSetupUtil.java
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/HsqlSetupUtil.java
index 2b9fb22a..534efc44 100644
---
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/HsqlSetupUtil.java
+++
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/HsqlSetupUtil.java
@@ -41,7 +41,7 @@ public final class HsqlSetupUtil
private static HSQLDiskCacheFactoryHelper factory = new
HSQLDiskCacheFactoryHelper();
/**
- * Set up a table for cache testing
+ * Sets up a table for cache testing
* <p>
* @param cConn
* @param tableName
diff --git
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/remote/MockRemoteCacheService.java
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/remote/MockRemoteCacheService.java
index eba39127..c5a3bbfe 100644
---
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/remote/MockRemoteCacheService.java
+++
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/auxiliary/remote/MockRemoteCacheService.java
@@ -84,7 +84,7 @@ public class MockRemoteCacheService<K, V>
}
/**
- * Set the last remove key.
+ * Sets the last remove key.
* <p>
* @param cacheName
* @param key
@@ -97,7 +97,7 @@ public class MockRemoteCacheService<K, V>
}
/**
- * Set the lastRemoveAllCacheName to the cacheName.
+ * Sets the lastRemoveAllCacheName to the cacheName.
*/
@Override
public void removeAll( final String cacheName, final long requesterId )
@@ -107,7 +107,7 @@ public class MockRemoteCacheService<K, V>
}
/**
- * Set the last update item.
+ * Sets the last update item.
* <p>
* @param item
* @param requesterId
@@ -150,7 +150,7 @@ public class MockRemoteCacheService<K, V>
}
/**
- * Set the last remove key.
+ * Sets the last remove key.
* <p>
* @param cacheName
* @param key
@@ -162,7 +162,7 @@ public class MockRemoteCacheService<K, V>
}
/**
- * Set the last remove all cache name.
+ * Sets the last remove all cache name.
* <p>
* @param cacheName
*/
@@ -173,7 +173,7 @@ public class MockRemoteCacheService<K, V>
}
/**
- * Set the last update item.
+ * Sets the last update item.
* <p>
* @param item
*/
diff --git
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/MockCacheServiceNonLocal.java
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/MockCacheServiceNonLocal.java
index 9f5c0b2b..1525a534 100644
---
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/MockCacheServiceNonLocal.java
+++
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/MockCacheServiceNonLocal.java
@@ -84,7 +84,7 @@ public class MockCacheServiceNonLocal<K, V>
}
/**
- * Set the last remove key.
+ * Sets the last remove key.
* <p>
* @param cacheName
* @param key
@@ -97,7 +97,7 @@ public class MockCacheServiceNonLocal<K, V>
}
/**
- * Set the lastRemoveAllCacheName to the cacheName.
+ * Sets the lastRemoveAllCacheName to the cacheName.
* <p>
* @param cacheName - region name
* @param requesterId - identity of requester
@@ -111,7 +111,7 @@ public class MockCacheServiceNonLocal<K, V>
}
/**
- * Set the last update item.
+ * Sets the last update item.
* <p>
* @param item
* @param requesterId - identity of requester
@@ -154,7 +154,7 @@ public class MockCacheServiceNonLocal<K, V>
}
/**
- * Set the last remove key.
+ * Sets the last remove key.
* <p>
* @param cacheName
* @param key
@@ -166,7 +166,7 @@ public class MockCacheServiceNonLocal<K, V>
}
/**
- * Set the last remove all cache name.
+ * Sets the last remove all cache name.
* <p>
* @param cacheName
*/
@@ -177,7 +177,7 @@ public class MockCacheServiceNonLocal<K, V>
}
/**
- * Set the last update item.
+ * Sets the last update item.
* <p>
* @param item
*/
diff --git
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderEncryptedUnitTest.java
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderEncryptedUnitTest.java
index 406a658f..0a1dc8a3 100644
---
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderEncryptedUnitTest.java
+++
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderEncryptedUnitTest.java
@@ -63,7 +63,7 @@ public class UDPDiscoverySenderEncryptedUnitTest
/**
- * Set up the receiver. Maybe better to just code sockets here? Set up the
sender for sending
+ * Sets up the receiver. Maybe better to just code sockets here? Set up
the sender for sending
* the message.
* <p>
* @throws Exception on error
diff --git
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderUnitTest.java
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderUnitTest.java
index 0a50d5a7..b5398aab 100644
---
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderUnitTest.java
+++
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoverySenderUnitTest.java
@@ -74,7 +74,7 @@ public class UDPDiscoverySenderUnitTest
private UDPDiscoverySender sender;
/**
- * Set up the receiver. Maybe better to just code sockets here? Set up the
sender for sending
+ * Sets up the receiver. Maybe better to just code sockets here? Set up
the sender for sending
* the message.
* <p>
* @throws Exception on error
