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 5b7a67f5 Normalize Javadoc @param formatting
new 20c4ccae Merge branch 'master' of
https://gitbox.apache.org/repos/asf/commons-jcs
5b7a67f5 is described below
commit 5b7a67f599d79d7fef05b4d86758bf487a36e93a
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Jun 16 11:56:31 2024 -0400
Normalize Javadoc @param formatting
---
.../apache/commons/jcs3/access/CacheAccess.java | 2 +-
.../commons/jcs3/access/behavior/ICacheAccess.java | 2 +-
.../jcs3/auxiliary/AuxiliaryCacheConfigurator.java | 4 ++--
.../disk/jdbc/mysql/MySQLDiskCacheFactory.java | 2 +-
.../socket/tcp/LateralTCPDiscoveryListener.java | 10 ++++-----
.../lateral/socket/tcp/LateralTCPService.java | 2 +-
.../remote/server/RemoteCacheServerFactory.java | 4 ++--
.../jcs3/engine/CacheEventQueueFactory.java | 2 +-
.../jcs3/engine/ZombieCacheServiceNonLocal.java | 26 +++++++++++-----------
.../engine/control/CompositeCacheConfigurator.java | 2 +-
.../jcs3/engine/control/CompositeCacheManager.java | 6 ++---
.../engine/logging/behavior/ICacheEventLogger.java | 24 ++++++++++----------
.../commons/jcs3/engine/stats/CacheStats.java | 2 +-
.../jcs3/engine/MockCacheServiceNonLocal.java | 12 +++++-----
14 files changed, 50 insertions(+), 50 deletions(-)
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/access/CacheAccess.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/access/CacheAccess.java
index 5009fbc1..db57cc28 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/access/CacheAccess.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/access/CacheAccess.java
@@ -171,7 +171,7 @@ public class CacheAccess<K, V>
/**
* Retrieve matching objects from the cache region this instance provides
access to.
* <p>
- * @param pattern - a key pattern for the objects stored
+ * @param pattern a key pattern for the objects stored
* @return A map of key to values. These are stripped from the wrapper.
*/
@Override
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/access/behavior/ICacheAccess.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/access/behavior/ICacheAccess.java
index 17b9478a..7df67de3 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/access/behavior/ICacheAccess.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/access/behavior/ICacheAccess.java
@@ -101,7 +101,7 @@ public interface ICacheAccess<K, V>
/**
* Retrieve matching objects from the cache region this instance provides
access to.
* <p>
- * @param pattern - a key pattern for the objects stored
+ * @param pattern a key pattern for the objects stored
* @return A map of key to values. These are stripped from the wrapper.
*/
Map<K, V> getMatching(String pattern);
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/AuxiliaryCacheConfigurator.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/AuxiliaryCacheConfigurator.java
index 1d23d2ce..2610087a 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/AuxiliaryCacheConfigurator.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/AuxiliaryCacheConfigurator.java
@@ -59,7 +59,7 @@ public class AuxiliaryCacheConfigurator
* Parses the event logger config, if there is any for the auxiliary.
* <p>
* @param props
- * @param auxPrefix - For example, AUXILIARY_PREFIX + auxName
+ * @param auxPrefix For example, AUXILIARY_PREFIX + auxName
* @return cacheEventLogger
*/
public static ICacheEventLogger parseCacheEventLogger( final Properties
props, final String auxPrefix )
@@ -86,7 +86,7 @@ public class AuxiliaryCacheConfigurator
* Parses the element config, if there is any for the auxiliary.
* <p>
* @param props
- * @param auxPrefix - For example, AUXILIARY_PREFIX + auxName
+ * @param auxPrefix For example, AUXILIARY_PREFIX + auxName
* @return cacheEventLogger
*/
public static IElementSerializer parseElementSerializer( final Properties
props, final String auxPrefix )
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/mysql/MySQLDiskCacheFactory.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/mysql/MySQLDiskCacheFactory.java
index 1e2768e4..0a22e591 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/mysql/MySQLDiskCacheFactory.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/mysql/MySQLDiskCacheFactory.java
@@ -97,7 +97,7 @@ public class MySQLDiskCacheFactory
/**
* This takes in a single time and schedules the optimizer to be called at
that time every day.
* <p>
- * @param startTime -- HH:MM:SS format
+ * @param startTime HH:MM:SS format
* @param optimizer
*/
protected void scheduleOptimization( final Date startTime, final
MySQLTableOptimizer optimizer )
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java
index 07aacc1c..5b1cc854 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java
@@ -216,8 +216,8 @@ public class LateralTCPDiscoveryListener
* This adds nowaits to a facade for the region name. If the region has no
facade, then it is
* not configured to use the lateral cache, and no facade will be created.
* <p>
- * @param cacheName - the region name
- * @param facade - facade (for region) => multiple lateral clients.
+ * @param cacheName the region name
+ * @param facade facade (for region) => multiple lateral clients.
* @return true if the facade was not already registered.
*/
public boolean addNoWaitFacade( final String cacheName, final
LateralCacheNoWaitFacade<?, ?> facade )
@@ -234,8 +234,8 @@ public class LateralTCPDiscoveryListener
/**
* Allows us to see if the facade is present and if it has the no wait.
* <p>
- * @param cacheName - facades are for a region
- * @param noWait - is this no wait in the facade
+ * @param cacheName facades are for a region
+ * @param noWait is this no wait in the facade
* @return do we contain the no wait. true if so
*/
public <K, V> boolean containsNoWait( final String cacheName, final
LateralCacheNoWait<K, V> noWait )
@@ -256,7 +256,7 @@ public class LateralTCPDiscoveryListener
/**
* Allows us to see if the facade is present.
* <p>
- * @param cacheName - facades are for a region
+ * @param cacheName facades are for a region
* @return do we contain the no wait. true if so
*/
public boolean containsNoWaitFacade( final String cacheName )
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPService.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPService.java
index 41f3b869..d7369979 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPService.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/lateral/socket/tcp/LateralTCPService.java
@@ -195,7 +195,7 @@ public class LateralTCPService<K, V>
* <p>
* @param cacheName
* @param pattern
- * @param requesterId - our identity
+ * @param requesterId our identity
* @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
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServerFactory.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServerFactory.java
index 57ae760f..6add75eb 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServerFactory.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServerFactory.java
@@ -150,8 +150,8 @@ public class RemoteCacheServerFactory
* Tries to lookup the server. If unsuccessful it will rebind the server
using the factory
* rebind method.
*
- * @param registryHost - Hostname of the registry
- * @param registryPort - the port on which to start the registry
+ * @param registryHost Hostname of the registry
+ * @param registryPort the port on which to start the registry
* @param cacheEventLogger the event logger for error messages
* @since 3.1
*/
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueueFactory.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueueFactory.java
index 40ed7d8b..4cca3f96 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueueFactory.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/CacheEventQueueFactory.java
@@ -72,7 +72,7 @@ public class CacheEventQueueFactory<K, V>
* @param listenerId
* @param cacheName
* @param threadPoolName
- * @param poolType - SINGLE, POOLED
+ * @param poolType SINGLE, POOLED
* @return ICacheEventQueue
*/
public ICacheEventQueue<K, V> createCacheEventQueue( final
ICacheListener<K, V> listener, final long listenerId, final String cacheName,
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 4f2833ed..4aba4f58 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
@@ -158,9 +158,9 @@ public class ZombieCacheServiceNonLocal<K, V>
/**
* Does nothing. Gets are synchronous and cannot be added to a queue.
* <p>
- * @param cacheName - region name
- * @param key - item key
- * @param requesterId - identifies the caller.
+ * @param cacheName region name
+ * @param key item key
+ * @param requesterId identifies the caller.
* @return null
* @throws IOException
*/
@@ -175,7 +175,7 @@ public class ZombieCacheServiceNonLocal<K, V>
/**
* Does nothing.
* <p>
- * @param cacheName - region name
+ * @param cacheName region name
* @return empty set
*/
@Override
@@ -201,9 +201,9 @@ public class ZombieCacheServiceNonLocal<K, V>
}
/**
- * @param cacheName - region name
- * @param keys - item key
- * @param requesterId - identity of the caller
+ * @param cacheName region name
+ * @param keys item key
+ * @param requesterId identity of the caller
* @return an empty map. zombies have no internal data
*/
@Override
@@ -267,9 +267,9 @@ public class ZombieCacheServiceNonLocal<K, V>
/**
* Adds a removeAll event to the queue if the maxSize is greater than 0;
* <p>
- * @param cacheName - region name
- * @param key - item key
- * @param listenerId - identifies the caller.
+ * @param cacheName region name
+ * @param key item key
+ * @param listenerId identifies the caller.
*/
@Override
public void remove( final String cacheName, final K key, final long
listenerId )
@@ -285,8 +285,8 @@ public class ZombieCacheServiceNonLocal<K, V>
/**
* Adds a removeAll event to the queue if the maxSize is greater than 0;
* <p>
- * @param cacheName - name of the region
- * @param listenerId - identifies the caller.
+ * @param cacheName name of the region
+ * @param listenerId identifies the caller.
*/
@Override
public void removeAll( final String cacheName, final long listenerId )
@@ -303,7 +303,7 @@ public class ZombieCacheServiceNonLocal<K, V>
* Adds an update event to the queue if the maxSize is greater than 0;
* <p>
* @param item ICacheElement
- * @param listenerId - identifies the caller.
+ * @param listenerId identifies the caller.
*/
@Override
public void update( final ICacheElement<K, V> item, final long listenerId )
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCacheConfigurator.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCacheConfigurator.java
index f5e28aa7..93d1a874 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCacheConfigurator.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCacheConfigurator.java
@@ -320,7 +320,7 @@ public class CompositeCacheConfigurator
* Creates a custom key matcher if one is defined. Else, it uses the
default.
* <p>
* @param props
- * @param auxPrefix - For example, AUXILIARY_PREFIX + auxName
+ * @param auxPrefix For example, AUXILIARY_PREFIX + auxName
* @return IKeyMatcher
*/
protected <K> IKeyMatcher<K> parseKeyMatcher( final Properties props,
final String auxPrefix )
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCacheManager.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCacheManager.java
index cc9ec303..cf34cf4d 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCacheManager.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCacheManager.java
@@ -291,7 +291,7 @@ public class CompositeCacheManager
* with the argument: -Djcs.auxiliary.LTCP.attributes.TcpListenerPort=1111
* </p>
* @param props
- * @param useSystemProperties -- if true, values starting with jcs will be
put into the props
+ * @param useSystemProperties if true, values starting with jcs will be
put into the props
* file prior to configuring the cache.
*/
public void configure( final Properties props, final boolean
useSystemProperties )
@@ -310,9 +310,9 @@ public class CompositeCacheManager
* with the argument: -Djcs.auxiliary.LTCP.attributes.TcpListenerPort=1111
* </p>
* @param props
- * @param useSystemProperties -- if true, values starting with jcs will be
put into the props
+ * @param useSystemProperties if true, values starting with jcs will be
put into the props
* file prior to configuring the cache.
- * @param forceReconfiguration - if the manager is already configured, we
will try again. This
+ * @param forceReconfiguration if the manager is already configured, we
will try again. This
* may not work properly.
*/
public synchronized void configure( final Properties props, final boolean
useSystemProperties, final boolean forceReconfiguration )
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/logging/behavior/ICacheEventLogger.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/logging/behavior/ICacheEventLogger.java
index 6c44e13f..581b2c8a 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/logging/behavior/ICacheEventLogger.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/logging/behavior/ICacheEventLogger.java
@@ -55,11 +55,11 @@ public interface ICacheEventLogger
/**
* Creates an event.
* <p>
- * @param source - e.g. RemoteCacheServer
- * @param region - the name of the region
- * @param eventName - e.g. update, get, put, remove
- * @param optionalDetails - any extra message
- * @param key - the cache key
+ * @param source e.g. RemoteCacheServer
+ * @param region the name of the region
+ * @param eventName e.g. update, get, put, remove
+ * @param optionalDetails any extra message
+ * @param key the cache key
* @return ICacheEvent
*/
<T> ICacheEvent<T> createICacheEvent( String source, String region,
@@ -68,25 +68,25 @@ public interface ICacheEventLogger
/**
* Logs an event. These are internal application events that do not
correspond to ICache calls.
* <p>
- * @param source - e.g. RemoteCacheServer
- * @param eventName - e.g. update, get, put, remove
- * @param optionalDetails - any extra message
+ * @param source e.g. RemoteCacheServer
+ * @param eventName e.g. update, get, put, remove
+ * @param optionalDetails any extra message
*/
void logApplicationEvent( String source, String eventName, String
optionalDetails );
/**
* Logs an error.
* <p>
- * @param source - e.g. RemoteCacheServer
- * @param eventName - e.g. update, get, put, remove
- * @param errorMessage - any error message
+ * @param source e.g. RemoteCacheServer
+ * @param eventName e.g. update, get, put, remove
+ * @param errorMessage any error message
*/
void logError( String source, String eventName, String errorMessage );
/**
* Logs an event.
* <p>
- * @param event - the event created in createICacheEvent
+ * @param event the event created in createICacheEvent
*/
<T> void logICacheEvent( ICacheEvent<T> event );
}
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/CacheStats.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/CacheStats.java
index 5bf01c56..d15bb3b3 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/CacheStats.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/stats/CacheStats.java
@@ -74,7 +74,7 @@ public class CacheStats
/**
* Stats are for a region, though auxiliary data may be for more.
* <p>
- * @param name - The region name
+ * @param name The region name
*/
@Override
public void setRegionName( final String name )
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 84a35e70..c8c9e28a 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>
/**
* @param cacheName
* @param key
- * @param requesterId - identity of requester
+ * @param requesterId identity of requester
* @return null
*/
@Override
@@ -148,7 +148,7 @@ public class MockCacheServiceNonLocal<K, V>
/**
* @param cacheName
* @param keys
- * @param requesterId - identity of requester
+ * @param requesterId identity of requester
* @return empty map
*/
@Override
@@ -183,7 +183,7 @@ public class MockCacheServiceNonLocal<K, V>
* <p>
* @param cacheName
* @param key
- * @param requesterId - identity of requester
+ * @param requesterId identity of requester
*/
@Override
public void remove( final String cacheName, final K key, final long
requesterId )
@@ -205,8 +205,8 @@ public class MockCacheServiceNonLocal<K, V>
/**
* Sets the lastRemoveAllCacheName to the cacheName.
* <p>
- * @param cacheName - region name
- * @param requesterId - identity of requester
+ * @param cacheName region name
+ * @param requesterId identity of requester
* @throws IOException
*/
@Override
@@ -231,7 +231,7 @@ public class MockCacheServiceNonLocal<K, V>
* Sets the last update item.
* <p>
* @param item
- * @param requesterId - identity of requester
+ * @param requesterId identity of requester
*/
@Override
public void update( final ICacheElement<K, V> item, final long requesterId
)
