This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 15f7f4f8 Javadoc
15f7f4f8 is described below
commit 15f7f4f86dc42a0d8e60520418d5891fc53779aa
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:49 2026 -0400
Javadoc
---
.../java/org/apache/commons/jcs4/access/CacheAccess.java | 4 ++--
.../commons/jcs4/access/behavior/ICacheAccess.java | 4 ++--
.../commons/jcs4/auxiliary/AbstractAuxiliaryCache.java | 2 +-
.../auxiliary/AbstractAuxiliaryCacheEventLogging.java | 10 +++++-----
.../apache/commons/jcs4/auxiliary/AuxiliaryCache.java | 2 +-
.../commons/jcs4/auxiliary/disk/AbstractDiskCache.java | 2 +-
.../commons/jcs4/auxiliary/disk/PurgatoryElement.java | 2 +-
.../commons/jcs4/auxiliary/disk/block/BlockDisk.java | 2 +-
.../jcs4/auxiliary/disk/block/BlockDiskCache.java | 2 +-
.../jcs4/auxiliary/disk/indexed/IndexedDiskCache.java | 4 ++--
.../jcs4/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java | 4 ++--
.../disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java | 2 +-
.../lateral/socket/tcp/LateralTCPCacheFactory.java | 4 ++--
.../lateral/socket/tcp/LateralTCPCacheNoWait.java | 2 +-
.../lateral/socket/tcp/LateralTCPCacheNoWaitFacade.java | 2 +-
.../auxiliary/lateral/socket/tcp/LateralTCPListener.java | 6 +++---
.../auxiliary/lateral/socket/tcp/LateralTCPService.java | 8 ++++----
.../remote/AbstractRemoteCacheNoWaitFacade.java | 4 ++--
.../commons/jcs4/auxiliary/remote/RemoteCacheNoWait.java | 2 +-
.../remote/http/client/RemoteHttpCacheClient.java | 8 ++++----
.../remote/http/server/AbstractRemoteCacheService.java | 6 +++---
.../jcs4/auxiliary/remote/server/RemoteCacheServer.java | 6 +++---
.../commons/jcs4/engine/CompositeCacheAttributes.java | 2 +-
.../apache/commons/jcs4/engine/ElementAttributes.java | 2 +-
.../commons/jcs4/engine/ZombieCacheServiceNonLocal.java | 2 +-
.../org/apache/commons/jcs4/engine/behavior/ICache.java | 6 +++---
.../commons/jcs4/engine/behavior/ICacheService.java | 4 ++--
.../jcs4/engine/behavior/ICacheServiceNonLocal.java | 6 +++---
.../commons/jcs4/engine/control/CompositeCache.java | 16 ++++++++--------
.../commons/jcs4/engine/memory/AbstractMemoryCache.java | 6 +++---
.../jcs4/engine/memory/behavior/IMemoryCache.java | 4 ++--
.../apache/commons/jcs4/engine/stats/StatElement.java | 2 +-
.../jcs4/utils/discovery/UDPDiscoveryAttributes.java | 2 +-
.../org/apache/commons/jcs4/utils/net/HostNameUtil.java | 2 +-
.../jcs4/utils/threadpool/DaemonThreadFactory.java | 2 +-
.../commons/jcs4/utils/threadpool/PoolConfiguration.java | 2 +-
.../test/java/org/apache/commons/jcs4/JCSUnitTest.java | 2 +-
.../commons/jcs4/auxiliary/MockAuxiliaryCache.java | 2 +-
.../commons/jcs4/auxiliary/disk/jdbc/HsqlSetupUtil.java | 2 +-
.../jcs4/auxiliary/remote/MockRemoteCacheClient.java | 2 +-
.../jcs4/auxiliary/remote/MockRemoteCacheService.java | 2 +-
.../commons/jcs4/engine/MockCacheServiceNonLocal.java | 2 +-
.../engine/control/CompositeCacheDiskUsageUnitTest.java | 2 +-
.../jcs4/engine/control/MockCompositeCacheManager.java | 2 +-
.../commons/jcs/utils/props/PropertiesFactory.java | 2 +-
.../apache/commons/jcs/yajcache/util/SerializeUtils.java | 2 +-
46 files changed, 83 insertions(+), 83 deletions(-)
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/CacheAccess.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/CacheAccess.java
index bb641b03..aa1e6349 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/CacheAccess.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/CacheAccess.java
@@ -133,7 +133,7 @@ public class CacheAccess<K, V>
* The last access time in the ElementAttributes should be current.
*
* @param names set of Serializable cache keys
- * @return a map of K key to ICacheElement<K, V> element, or empty
map if none of the keys are present
+ * @return A map of K key to ICacheElement<K, V> element, or empty
map if none of the keys are present
*/
@Override
public Map<K, ICacheElement<K, V>> getCacheElements( final Set<K> names )
@@ -211,7 +211,7 @@ public class CacheAccess<K, V>
* The last access time in the ElementAttributes should be current.
*
* @param pattern key search pattern
- * @return a map of K key to ICacheElement<K, V> element, or empty
map if no keys match the pattern
+ * @return A map of K key to ICacheElement<K, V> element, or empty
map if no keys match the pattern
*/
@Override
public Map<K, ICacheElement<K, V>> getMatchingCacheElements( final String
pattern )
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/ICacheAccess.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/ICacheAccess.java
index c95ea5aa..cdd50954 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/ICacheAccess.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/access/behavior/ICacheAccess.java
@@ -83,7 +83,7 @@ public interface ICacheAccess<K, V>
* The last access time in the ElementAttributes should be current.
*
* @param names set of Object cache keys
- * @return a map of Object key to ICacheElement<K, V> element, or
empty map if none of the keys are
+ * @return A map of Object key to ICacheElement<K, V> element, or
empty map if none of the keys are
* present
*/
Map<K, ICacheElement<K, V>> getCacheElements(Set<K> names);
@@ -121,7 +121,7 @@ public interface ICacheAccess<K, V>
* The last access time in the ElementAttributes should be current.
*
* @param pattern key search pattern
- * @return a map of Object key to ICacheElement<K, V> element, or
empty map if no keys match the
+ * @return A map of Object key to ICacheElement<K, V> element, or
empty map if no keys match the
* pattern
*/
Map<K, ICacheElement<K, V>> getMatchingCacheElements(String pattern);
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCache.java
index adcdd058..0627bff7 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCache.java
@@ -102,7 +102,7 @@ public abstract class AbstractAuxiliaryCache<K, V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
*/
protected Map<K, ICacheElement<K, V>> processGetMultiple(final Set<K>
keys) throws IOException
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCacheEventLogging.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCacheEventLogging.java
index 096833d4..edef11b9 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCacheEventLogging.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AbstractAuxiliaryCacheEventLogging.java
@@ -94,7 +94,7 @@ public abstract class AbstractAuxiliaryCacheEventLogging<K, V>
* cache will convert * to % and . to _
*
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data matching the pattern.
* @throws IOException
*/
@@ -109,7 +109,7 @@ public abstract class AbstractAuxiliaryCacheEventLogging<K,
V>
* Gets matching items from the cache based on the given pattern.
*
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data matching the pattern.
* @throws IOException
*/
@@ -132,7 +132,7 @@ public abstract class AbstractAuxiliaryCacheEventLogging<K,
V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
@@ -147,7 +147,7 @@ public abstract class AbstractAuxiliaryCacheEventLogging<K,
V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
@@ -210,7 +210,7 @@ public abstract class AbstractAuxiliaryCacheEventLogging<K,
V>
* Implements getMatching.
*
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data matching the pattern.
* @throws IOException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCache.java
index 6c1c1e5e..43b57577 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/AuxiliaryCache.java
@@ -44,7 +44,7 @@ public interface AuxiliaryCache<K, V>
/**
* Gets a set of the keys for all elements in the auxiliary cache.
*
- * @return a set of the key type
+ * @return A set of the key type
* TODO This should probably be done in chunks with a range passed in. This
* will be a problem if someone puts a 1,000,000 or so items in a
* region.
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCache.java
index 75ef2ad0..b0f97a90 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/AbstractDiskCache.java
@@ -400,7 +400,7 @@ public abstract class AbstractDiskCache<K, V>
* cache will convert * to % and . to _
*
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data matching the pattern.
* @throws IOException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/PurgatoryElement.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/PurgatoryElement.java
index 378eff36..dbed4d45 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/PurgatoryElement.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/PurgatoryElement.java
@@ -92,7 +92,7 @@ public record PurgatoryElement<K, V>(
}
/**
- * @return a hash of the key only
+ * @return A hash of the key only
*/
@Override
public int hashCode()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDisk.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDisk.java
index e5ef019b..922f08c6 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDisk.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDisk.java
@@ -99,7 +99,7 @@ public class BlockDisk implements AutoCloseable
* Allocate a given number of blocks from the available set
*
* @param numBlocksNeeded
- * @return an array of allocated blocks
+ * @return An array of allocated blocks
*/
private int[] allocateBlocks(final int numBlocksNeeded)
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskCache.java
index fea325dd..96cbc251 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/block/BlockDiskCache.java
@@ -428,7 +428,7 @@ public class BlockDiskCache<K, V>
* Gets matching items from the cache.
*
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache matching keys
*/
@Override
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCache.java
index c6ca4f46..480c1e9a 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/indexed/IndexedDiskCache.java
@@ -494,7 +494,7 @@ public class IndexedDiskCache<K, V> extends
AbstractDiskCache<K, V>
/**
* Create the map for keys that contain the index position on disk.
*
- * @return a new empty Map for keys and IndexedDiskElementDescriptors
+ * @return A new empty Map for keys and IndexedDiskElementDescriptors
*/
private Map<K, IndexedDiskElementDescriptor> createInitialKeyMap()
{
@@ -1293,7 +1293,7 @@ public class IndexedDiskCache<K, V> extends
AbstractDiskCache<K, V>
* <p>
*
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache matching keys
*/
@Override
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
index b0f86835..d41f195c 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
@@ -162,7 +162,7 @@ public class JDBCDiskCacheFactory
*
* @param cattr the cache configuration
* @param configProps the configuration properties object
- * @return a DataSourceFactory
+ * @return A DataSourceFactory
* @throws SQLException if a database access error occurs
*/
protected DataSourceFactory getDataSourceFactory( final
JDBCDiskCacheAttributes cattr,
@@ -233,7 +233,7 @@ public class JDBCDiskCacheFactory
* Gets a table state for a given table name
*
* @param tableName
- * @return a cached instance of the table state
+ * @return A cached instance of the table state
*/
protected TableState getTableState(final String tableName)
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java
index 437895ed..f0d76a92 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/dsfactory/SharedPoolDataSourceFactory.java
@@ -45,7 +45,7 @@ public class SharedPoolDataSourceFactory implements
DataSourceFactory
*
* @param config where to read the settings from
* @throws SQLException if a property set fails
- * @return a configured {@code ConnectionPoolDataSource}
+ * @return A configured {@code ConnectionPoolDataSource}
*/
private static ConnectionPoolDataSource initCPDS(final
JDBCDiskCacheAttributes config)
throws SQLException
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
index cc72f434..c896d97b 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
@@ -159,7 +159,7 @@ public class LateralTCPCacheFactory
* @param cacheEventLogger the cache event logger
* @param elementSerializer the serializer for cache elements
* @param keyMatcher the key matcher for getMatching() calls
- * @return a LateralTCPCacheNoWaitFacade
+ * @return A LateralTCPCacheNoWaitFacade
*/
@Override
public <K, V> LateralTCPCacheNoWaitFacade<K, V> createCache(final
AuxiliaryCacheAttributes iaca,
@@ -216,7 +216,7 @@ public class LateralTCPCacheFactory
* @param cacheEventLogger the event logger
* @param elementSerializer the serializer to use when sending or receiving
* @param keyMatcher the key matcher for getMatching() calls
- * @return a LateralTCPCacheNoWait
+ * @return A LateralTCPCacheNoWait
*/
public <K, V> LateralTCPCacheNoWait<K, V> createCacheNoWait( final
ILateralTCPCacheAttributes lca,
final ICacheEventLogger cacheEventLogger, final IElementSerializer
elementSerializer,
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWait.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWait.java
index ddf22290..69ab4cf1 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWait.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWait.java
@@ -270,7 +270,7 @@ public class LateralTCPCacheNoWait<K, V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
*/
@Override
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWaitFacade.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWaitFacade.java
index 0163d10a..9de629e8 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWaitFacade.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPCacheNoWaitFacade.java
@@ -215,7 +215,7 @@ public class LateralTCPCacheNoWaitFacade<K, V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
*/
@Override
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPListener.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPListener.java
index 81ef6276..93093ecf 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPListener.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPListener.java
@@ -280,7 +280,7 @@ public class LateralTCPListener<K, V>
* descriptor.
*
* @param led the lateral element
- * @return a possible response
+ * @return A possible response
* @throws IOException
*/
private Object handleElement(final LateralElementDescriptor<K, V> led)
throws IOException
@@ -346,7 +346,7 @@ public class LateralTCPListener<K, V>
*
* @param cacheName
* @param key
- * @return a ICacheElement
+ * @return A ICacheElement
* @throws IOException
*/
public ICacheElement<K, V> handleGet( final String cacheName, final K key )
@@ -369,7 +369,7 @@ public class LateralTCPListener<K, V>
* Gets the cache that was injected by the lateral factory. Calls
getKeySet on the cache.
*
* @param cacheName the name of the cache
- * @return a set of keys
+ * @return A set of keys
* @throws IOException
*/
public Set<K> handleGetKeySet( final String cacheName ) throws IOException
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPService.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPService.java
index 7de88653..9457a018 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPService.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/lateral/socket/tcp/LateralTCPService.java
@@ -177,7 +177,7 @@ public class LateralTCPService<K, V>
*
* @param cacheName
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache matching the pattern.
* @throws IOException
*/
@@ -194,7 +194,7 @@ public class LateralTCPService<K, V>
* @param cacheName
* @param pattern
* @param requesterId our identity
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache matching the pattern.
* @throws IOException
*/
@@ -226,7 +226,7 @@ public class LateralTCPService<K, V>
*
* @param cacheName
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
@@ -245,7 +245,7 @@ public class LateralTCPService<K, V>
* @param cacheName
* @param keys
* @param requesterId
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
index f964060d..45fe20e0 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
@@ -166,7 +166,7 @@ public abstract class AbstractRemoteCacheNoWaitFacade<K, V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
*/
@Override
@@ -186,7 +186,7 @@ public abstract class AbstractRemoteCacheNoWaitFacade<K, V>
/**
* Gets the primary server from the list of failovers
*
- * @return a no wait
+ * @return A no wait
*/
public RemoteCacheNoWait<K, V> getPrimaryServer()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheNoWait.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheNoWait.java
index 683d8b26..f66db609 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheNoWait.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/RemoteCacheNoWait.java
@@ -269,7 +269,7 @@ public class RemoteCacheNoWait<K, V>
* request on to the server rather than looping through the requested keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheClient.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheClient.java
index f22e7911..5837d0b5 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheClient.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/client/RemoteHttpCacheClient.java
@@ -173,7 +173,7 @@ public class RemoteHttpCacheClient<K, V>
*
* @param cacheName
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache matching the pattern.
* @throws IOException
*/
@@ -190,7 +190,7 @@ public class RemoteHttpCacheClient<K, V>
* @param cacheName
* @param pattern
* @param requesterId
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache matching the pattern.
* @throws IOException
*/
@@ -221,7 +221,7 @@ public class RemoteHttpCacheClient<K, V>
*
* @param cacheName
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
@@ -238,7 +238,7 @@ public class RemoteHttpCacheClient<K, V>
* @param cacheName
* @param keys
* @param requesterId
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/server/AbstractRemoteCacheService.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/server/AbstractRemoteCacheService.java
index aded0103..b1c80064 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/server/AbstractRemoteCacheService.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/http/server/AbstractRemoteCacheService.java
@@ -235,7 +235,7 @@ public abstract class AbstractRemoteCacheService<K, V>
*
* @param cacheName
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
@@ -254,7 +254,7 @@ public abstract class AbstractRemoteCacheService<K, V>
* @param cacheName
* @param keys
* @param requesterId
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
@@ -348,7 +348,7 @@ public abstract class AbstractRemoteCacheService<K, V>
* @param cacheName
* @param keys
* @param requesterId
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServer.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServer.java
index 7ad11cf3..1c806357 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServer.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/auxiliary/remote/server/RemoteCacheServer.java
@@ -633,7 +633,7 @@ public class RemoteCacheServer<K, V>
*
* @param cacheName
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
@@ -652,7 +652,7 @@ public class RemoteCacheServer<K, V>
* @param cacheName
* @param keys
* @param requesterId
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
@@ -963,7 +963,7 @@ public class RemoteCacheServer<K, V>
* @param cacheName
* @param keys
* @param requesterId
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
*/
private Map<K, ICacheElement<K, V>> processGetMultiple( final String
cacheName, final Set<K> keys, final long requesterId )
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/CompositeCacheAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/CompositeCacheAttributes.java
index 2352a0af..61003d08 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/CompositeCacheAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/CompositeCacheAttributes.java
@@ -98,7 +98,7 @@ public record CompositeCacheAttributes(
);
/**
- * @return an object containing the default settings
+ * @return An object containing the default settings
*/
public static CompositeCacheAttributes defaults()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ElementAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ElementAttributes.java
index 7fa28d89..5a5e032e 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ElementAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ElementAttributes.java
@@ -123,7 +123,7 @@ public record ElementAttributes(
new ArrayList<>());
/**
- * @return an object containing the default settings
+ * @return An object containing the default settings
*/
public static ElementAttributes defaults()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ZombieCacheServiceNonLocal.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ZombieCacheServiceNonLocal.java
index 0fb5da07..38cec466 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ZombieCacheServiceNonLocal.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/ZombieCacheServiceNonLocal.java
@@ -203,7 +203,7 @@ public class ZombieCacheServiceNonLocal<K, V>
* @param cacheName region name
* @param keys item key
* @param requesterId identity of the caller
- * @return an empty map. zombies have no internal data
+ * @return An empty map. zombies have no internal data
*/
@Override
public Map<K, ICacheElement<K, V>> getMultiple( final String cacheName,
final Set<K> keys, final long requesterId )
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICache.java
index 764ccab7..5377a5b4 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICache.java
@@ -51,7 +51,7 @@ public interface ICache<K, V>
* Gets an item from the cache.
*
* @param key
- * @return a cache element, or null if there is no data in cache for this
key
+ * @return A cache element, or null if there is no data in cache for this
key
* @throws IOException
*/
ICacheElement<K, V> get( K key )
@@ -72,7 +72,7 @@ public interface ICache<K, V>
* Auxiliaries will do their best to handle simple expressions. For
instance, the JDBC disk cache will convert * to % and . to _
*
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no data matching the pattern.
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no data matching the pattern.
* @throws IOException
*/
Map<K, ICacheElement<K, V>> getMatching(String pattern)
@@ -82,7 +82,7 @@ public interface ICache<K, V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no data in cache for any of these keys
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no data in cache for any of these keys
* @throws IOException
*/
Map<K, ICacheElement<K, V>> getMultiple(Set<K> keys)
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheService.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheService.java
index e9994a45..bf91375d 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheService.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheService.java
@@ -56,7 +56,7 @@ public interface ICacheService<K, V>
*
* @param cacheName
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache matching the pattern.
* @throws IOException
*/
@@ -68,7 +68,7 @@ public interface ICacheService<K, V>
*
* @param cacheName
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheServiceNonLocal.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheServiceNonLocal.java
index d8aada71..1ddb676c 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheServiceNonLocal.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/behavior/ICacheServiceNonLocal.java
@@ -52,7 +52,7 @@ public interface ICacheServiceNonLocal<K, V>
* Gets a set of the keys for all elements in the cache.
*
* @param cacheName the name of the cache
- * @return a set of the key type
+ * @return A set of the key type
* TODO This should probably be done in chunks with a range passed in. This
* will be a problem if someone puts a 1,000,000 or so items in a
* region.
@@ -65,7 +65,7 @@ public interface ICacheServiceNonLocal<K, V>
* @param cacheName
* @param pattern
* @param requesterId
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache matching the pattern.
* @throws IOException
*/
@@ -78,7 +78,7 @@ public interface ICacheServiceNonLocal<K, V>
* @param cacheName
* @param keys
* @param requesterId
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java
index 27060aa1..b8560edd 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/control/CompositeCache.java
@@ -456,7 +456,7 @@ public class CompositeCache<K, V>
/**
* Gets the list of auxiliary caches for this region.
*
- * @return a list of auxiliary caches, may be empty, never null
+ * @return A list of auxiliary caches, may be empty, never null
* @since 3.1
*/
public List<AuxiliaryCache<K, V>> getAuxCacheList()
@@ -591,7 +591,7 @@ public class CompositeCache<K, V>
* Build a map of all the matching elements in all of the auxiliaries and
memory.
*
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any matching keys
*/
@Override
@@ -610,7 +610,7 @@ public class CompositeCache<K, V>
*
* @param pattern
* @param localOnly
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any matching keys
*/
protected Map<K, ICacheElement<K, V>> getMatching(final String pattern,
final boolean localOnly)
@@ -644,7 +644,7 @@ public class CompositeCache<K, V>
*
* @param pattern
* @param localOnly
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any matching keys
* @throws IOException
*/
@@ -691,7 +691,7 @@ public class CompositeCache<K, V>
* set. Returns a map: key -> result.
*
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any matching keys
* @throws IOException
*/
@@ -739,7 +739,7 @@ public class CompositeCache<K, V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
*/
@Override
@@ -1050,7 +1050,7 @@ public class CompositeCache<K, V>
* go remote or laterally for this data.
*
* @param pattern
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any matching keys
*/
public Map<K, ICacheElement<K, V>> localGetMatching(final String pattern)
@@ -1063,7 +1063,7 @@ public class CompositeCache<K, V>
* laterally for this data.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
*/
public Map<K, ICacheElement<K, V>> localGetMultiple(final Set<K> keys)
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractMemoryCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractMemoryCache.java
index 708a4212..7255bd20 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractMemoryCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/AbstractMemoryCache.java
@@ -78,7 +78,7 @@ public abstract class AbstractMemoryCache<K, V>
* Children must implement this method. A FIFO implementation may use a
tree map. An LRU might
* use a hashtable. The map returned should be threadsafe.
*
- * @return a threadsafe Map
+ * @return A threadsafe Map
*/
public abstract Map<K, MemoryElementDescriptor<K, V>> createMap();
@@ -197,7 +197,7 @@ public abstract class AbstractMemoryCache<K, V>
/**
* Gets a set of the keys for all elements in the memory cache
*
- * @return a set of keys
+ * @return A set of keys
*/
@Override
public Set<K> getKeySet()
@@ -209,7 +209,7 @@ public abstract class AbstractMemoryCache<K, V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
* @throws IOException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/behavior/IMemoryCache.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/behavior/IMemoryCache.java
index ad37f575..f86a3569 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/behavior/IMemoryCache.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/memory/behavior/IMemoryCache.java
@@ -82,7 +82,7 @@ public interface IMemoryCache<K, V>
/**
* Gets a set of the keys for all elements in the memory cache.
*
- * @return a set of the key type
+ * @return A set of the key type
* TODO This should probably be done in chunks with a range passed in. This
* will be a problem if someone puts a 1,000,000 or so items in a
* region.
@@ -93,7 +93,7 @@ public interface IMemoryCache<K, V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map
* if there is no data in cache for any of these keys
* @throws IOException
*/
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/StatElement.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/StatElement.java
index 2b443693..bdbdaaa0 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/StatElement.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/engine/stats/StatElement.java
@@ -28,7 +28,7 @@ public record StatElement<V>(String name, V data)
implements IStatElement<V>
{
/**
- * @return a readable string.
+ * @return A readable string.
*/
@Override
public String toString()
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryAttributes.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryAttributes.java
index 452b1b78..c5f06a9f 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryAttributes.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/discovery/UDPDiscoveryAttributes.java
@@ -73,7 +73,7 @@ public record UDPDiscoveryAttributes(
);
/**
- * @return an object containing the default settings
+ * @return An object containing the default settings
*/
public static UDPDiscoveryAttributes defaults()
{
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/net/HostNameUtil.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/net/HostNameUtil.java
index 672b3682..89ba1ad8 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/net/HostNameUtil.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/net/HostNameUtil.java
@@ -188,7 +188,7 @@ public class HostNameUtil
* On systems with multiple network interfaces and mixed IPv6/IPv4 get a
valid network
* interface for binding to multicast
*
- * @return a network interface suitable for multicast
+ * @return A network interface suitable for multicast
* @throws SocketException if a problem occurs while reading the network
interfaces
*/
public static NetworkInterface getMulticastNetworkInterface() throws
SocketException
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/threadpool/DaemonThreadFactory.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/threadpool/DaemonThreadFactory.java
index 221dc52c..c751ee12 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/threadpool/DaemonThreadFactory.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/threadpool/DaemonThreadFactory.java
@@ -57,7 +57,7 @@ public class DaemonThreadFactory
* Sets the thread to daemon.
*
* @param runner
- * @return a daemon thread
+ * @return A daemon thread
*/
@Override
public Thread newThread( final Runnable runner )
diff --git
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/threadpool/PoolConfiguration.java
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/threadpool/PoolConfiguration.java
index f99017c2..aa88096b 100644
---
a/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/threadpool/PoolConfiguration.java
+++
b/commons-jcs4-core/src/main/java/org/apache/commons/jcs4/utils/threadpool/PoolConfiguration.java
@@ -96,7 +96,7 @@ public record PoolConfiguration(
DEFAULT_KEEPALIVE_TIME, DEFAULT_WHEN_BLOCKED_POLICY,
DEFAULT_STARTUP_SIZE);
/**
- * @return an object containing the default settings
+ * @return An object containing the default settings
*/
public static PoolConfiguration defaults()
{
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/JCSUnitTest.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/JCSUnitTest.java
index eafd88e0..dbf78a66 100644
--- a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/JCSUnitTest.java
+++ b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/JCSUnitTest.java
@@ -52,7 +52,7 @@ class JCSUnitTest
}
/**
- * @return a map
+ * @return A map
*/
private HashMap<String, String> buildMap()
{
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/MockAuxiliaryCache.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/MockAuxiliaryCache.java
index 79a43a94..6c8d7422 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/MockAuxiliaryCache.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/MockAuxiliaryCache.java
@@ -113,7 +113,7 @@ public class MockAuxiliaryCache<K, V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<String, String> element,
or an empty map if there is no
+ * @return A map of K key to ICacheElement<String, String> element,
or an empty map if there is no
* data in cache for any of these keys
*/
@Override
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/HsqlSetupUtil.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/HsqlSetupUtil.java
index 3e5d3c6c..5daf3bbc 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/HsqlSetupUtil.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/disk/jdbc/HsqlSetupUtil.java
@@ -45,7 +45,7 @@ public final class HsqlSetupUtil
*
* @param testProperties test database properties
* @param testDBName name of the test database
- * @return a connection to the database
+ * @return A connection to the database
* @throws Exception
*/
public static Connection getTestDatabaseConnection(final Properties
testProperties, final String testDBName)
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/MockRemoteCacheClient.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/MockRemoteCacheClient.java
index 0f93e219..eaefa86e 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/MockRemoteCacheClient.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/MockRemoteCacheClient.java
@@ -168,7 +168,7 @@ public class MockRemoteCacheClient<K, V>
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is no
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is no
* data in cache for any of these keys
*/
@Override
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/MockRemoteCacheService.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/MockRemoteCacheService.java
index 849557c2..b1427793 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/MockRemoteCacheService.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/auxiliary/remote/MockRemoteCacheService.java
@@ -109,7 +109,7 @@ public class MockRemoteCacheService<K, V>
*
* @param cacheName
* @param pattern
- * @return an empty map
+ * @return An empty map
* @throws IOException
*/
@Override
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/MockCacheServiceNonLocal.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/MockCacheServiceNonLocal.java
index ea75d2f3..f96bbc2b 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/MockCacheServiceNonLocal.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/MockCacheServiceNonLocal.java
@@ -109,7 +109,7 @@ public class MockCacheServiceNonLocal<K, V>
*
* @param cacheName
* @param pattern
- * @return an empty map
+ * @return An empty map
* @throws IOException
*/
@Override
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheDiskUsageUnitTest.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheDiskUsageUnitTest.java
index 7c634f57..b2c092fc 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheDiskUsageUnitTest.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/CompositeCacheDiskUsageUnitTest.java
@@ -133,7 +133,7 @@ class CompositeCacheDiskUsageUnitTest
* Gets multiple items from the cache based on the given set of keys.
*
* @param keys
- * @return a map of K key to ICacheElement<K, V> element, or an
empty map if there is
+ * @return A map of K key to ICacheElement<K, V> element, or an
empty map if there is
* no data in cache for any of these keys
*/
@Override
diff --git
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/MockCompositeCacheManager.java
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/MockCompositeCacheManager.java
index 9c45e48b..13141c6d 100644
---
a/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/MockCompositeCacheManager.java
+++
b/commons-jcs4-core/src/test/java/org/apache/commons/jcs4/engine/control/MockCompositeCacheManager.java
@@ -63,7 +63,7 @@ public class MockCompositeCacheManager
/**
* @param cacheName
- * @return a CompositeCache
+ * @return A CompositeCache
*/
@Override
@SuppressWarnings("unchecked")
diff --git
a/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/utils/props/PropertiesFactory.java
b/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/utils/props/PropertiesFactory.java
index fb2edc7a..8d73229b 100644
---
a/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/utils/props/PropertiesFactory.java
+++
b/commons-jcs4-sandbox/commons-jcs4-partitioned/src/main/java/org/apache/commons/jcs/utils/props/PropertiesFactory.java
@@ -30,7 +30,7 @@ public interface PropertiesFactory
* Fetches a set of properties for the specified group.
*
* @param groupName the group to pull properties from.
- * @return a properties object.
+ * @return A properties object.
*/
Properties getProperties( String groupName );
}
diff --git
a/commons-jcs4-sandbox/commons-jcs4-yajcache/src/main/java/org/apache/commons/jcs/yajcache/util/SerializeUtils.java
b/commons-jcs4-sandbox/commons-jcs4-yajcache/src/main/java/org/apache/commons/jcs/yajcache/util/SerializeUtils.java
index d070048b..b4bca64b 100644
---
a/commons-jcs4-sandbox/commons-jcs4-yajcache/src/main/java/org/apache/commons/jcs/yajcache/util/SerializeUtils.java
+++
b/commons-jcs4-sandbox/commons-jcs4-yajcache/src/main/java/org/apache/commons/jcs/yajcache/util/SerializeUtils.java
@@ -34,7 +34,7 @@ public enum SerializeUtils {
/**
* Duplicates the given object.
*
- * @return a duplicate of the given Serializable object,
+ * @return A duplicate of the given Serializable object,
* short-cutting the deep clone process if possible.
*/
public <V extends Serializable> V dup(final V obj) {
