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 f07b4c7e Normalize getter Javadoc
f07b4c7e is described below
commit f07b4c7ed58503bda15d70ca77f509fc56c22b39
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Oct 31 06:49:49 2023 -0400
Normalize getter Javadoc
---
.../commons/jcs/auxiliary/javagroups/JavaGroupsCache.java | 2 +-
.../commons/jcs/auxiliary/javagroups/JavaGroupsCache.java | 2 +-
.../src/main/java/org/apache/commons/jcs3/JCS.java | 12 ++++++------
.../java/org/apache/commons/jcs3/access/CacheAccess.java | 4 ++--
.../apache/commons/jcs3/access/behavior/ICacheAccess.java | 4 ++--
.../org/apache/commons/jcs3/auxiliary/AuxiliaryCache.java | 2 +-
.../commons/jcs3/auxiliary/disk/AbstractDiskCache.java | 4 ++--
.../jcs3/auxiliary/disk/AbstractDiskCacheAttributes.java | 2 +-
.../apache/commons/jcs3/auxiliary/disk/PurgatoryElement.java | 2 +-
.../jcs3/auxiliary/disk/behavior/IDiskCacheAttributes.java | 2 +-
.../jcs3/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java | 4 ++--
.../auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java | 2 +-
.../apache/commons/jcs3/auxiliary/remote/RemoteCache.java | 2 +-
.../apache/commons/jcs3/auxiliary/remote/RemoteUtils.java | 4 ++--
.../jcs3/auxiliary/remote/behavior/IRemoteCacheListener.java | 2 +-
.../auxiliary/remote/http/server/RemoteHttpCacheServlet.java | 2 +-
.../jcs3/auxiliary/remote/server/RemoteCacheServer.java | 2 +-
.../jcs3/auxiliary/remote/value/RemoteRequestType.java | 8 ++++----
.../commons/jcs3/engine/behavior/ICacheServiceNonLocal.java | 2 +-
.../commons/jcs3/engine/behavior/IProvideScheduler.java | 2 +-
.../apache/commons/jcs3/engine/control/CompositeCache.java | 6 +++---
.../jcs3/engine/control/CompositeCacheConfigurator.java | 10 +++++-----
.../commons/jcs3/engine/control/CompositeCacheManager.java | 8 ++++----
.../commons/jcs3/engine/memory/AbstractMemoryCache.java | 6 +++---
.../commons/jcs3/engine/memory/behavior/IMemoryCache.java | 8 ++++----
.../jcs3/engine/memory/util/MemoryElementDescriptor.java | 2 +-
.../org/apache/commons/jcs3/engine/stats/StatElement.java | 4 ++--
.../commons/jcs3/engine/stats/behavior/IStatElement.java | 4 ++--
.../apache/commons/jcs3/engine/stats/behavior/IStats.java | 2 +-
.../commons/jcs3/utils/discovery/UDPDiscoveryService.java | 2 +-
.../jcs3/engine/memory/lru/LHMLRUMemoryCacheUnitTest.java | 2 +-
.../jcs3/engine/memory/mru/MRUMemoryCacheUnitTest.java | 2 +-
.../jcs3/utils/threadpool/ThreadPoolManagerUnitTest.java | 2 +-
.../jcs/auxiliary/disk/file/FileDiskCacheManager.java | 2 +-
.../lateral/http/server/LateralCacheServletReciever.java | 2 +-
.../apache/commons/jcs/engine/memory/arc/ARCMemoryCache.java | 2 +-
36 files changed, 65 insertions(+), 65 deletions(-)
diff --git
a/auxiliary-builds/javagroups/src/java/org/apache/commons/jcs/auxiliary/javagroups/JavaGroupsCache.java
b/auxiliary-builds/javagroups/src/java/org/apache/commons/jcs/auxiliary/javagroups/JavaGroupsCache.java
index 917bf05d..6980e2d5 100644
---
a/auxiliary-builds/javagroups/src/java/org/apache/commons/jcs/auxiliary/javagroups/JavaGroupsCache.java
+++
b/auxiliary-builds/javagroups/src/java/org/apache/commons/jcs/auxiliary/javagroups/JavaGroupsCache.java
@@ -279,7 +279,7 @@ public class JavaGroupsCache
// --------------------------------------------------- interface ICacheType
/**
- * Get the cache type (always Lateral).
+ * Gets the cache type (always Lateral).
*
* @return Always returns ICacheType.LATERAL_CACHE
*/
diff --git
a/auxiliary-builds/jdk14/src/java/org/apache/commons/jcs/auxiliary/javagroups/JavaGroupsCache.java
b/auxiliary-builds/jdk14/src/java/org/apache/commons/jcs/auxiliary/javagroups/JavaGroupsCache.java
index bb38d4ee..2994a070 100644
---
a/auxiliary-builds/jdk14/src/java/org/apache/commons/jcs/auxiliary/javagroups/JavaGroupsCache.java
+++
b/auxiliary-builds/jdk14/src/java/org/apache/commons/jcs/auxiliary/javagroups/JavaGroupsCache.java
@@ -288,7 +288,7 @@ public class JavaGroupsCache
// --------------------------------------------------- interface ICacheType
/**
- * Get the cache type (always Lateral).
+ * Gets the cache type (always Lateral).
*
* @return Always returns ICacheType.LATERAL_CACHE
*/
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 fb19e518..b9484880 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
@@ -132,7 +132,7 @@ public abstract class JCS
}
/**
- * Get a CacheAccess which accesses the provided region.
+ * Gets a CacheAccess which accesses the provided region.
* <p>
* @param region Region that return CacheAccess will provide access to
* @return A CacheAccess which provides access to a given region.
@@ -146,7 +146,7 @@ public abstract class JCS
}
/**
- * Get a CacheAccess which accesses the provided region.
+ * Gets a CacheAccess which accesses the provided region.
* <p>
* @param region Region that return CacheAccess will provide access to
* @param icca CacheAttributes for region
@@ -161,7 +161,7 @@ public abstract class JCS
}
/**
- * Get a CacheAccess which accesses the provided region.
+ * Gets a CacheAccess which accesses the provided region.
* <p>
* @param region Region that return CacheAccess will provide access to
* @param icca CacheAttributes for region
@@ -177,7 +177,7 @@ public abstract class JCS
}
/**
- * Get a GroupCacheAccess which accesses the provided region.
+ * Gets a GroupCacheAccess which accesses the provided region.
* <p>
* @param region Region that return GroupCacheAccess will provide access to
* @return A GroupCacheAccess which provides access to a given region.
@@ -191,7 +191,7 @@ public abstract class JCS
}
/**
- * Get a GroupCacheAccess which accesses the provided region.
+ * Gets a GroupCacheAccess which accesses the provided region.
* <p>
* @param region Region that return GroupCacheAccess will provide access to
* @param icca CacheAttributes for region
@@ -206,7 +206,7 @@ public abstract class JCS
}
/**
- * Get a GroupCacheAccess which accesses the provided region.
+ * Gets a GroupCacheAccess which accesses the provided region.
* <p>
* @param region Region that return CacheAccess will provide access to
* @param icca CacheAttributes for region
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 68a0652b..3b0afce1 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
@@ -151,7 +151,7 @@ public class CacheAccess<K, V>
}
/**
- * Get multiple elements from the cache based on a set of cache keys.
+ * Gets multiple elements from the cache based on a set of cache keys.
* <p>
* This method returns the ICacheElement<K, V> wrapper which
provides access to element info and other
* attributes.
@@ -174,7 +174,7 @@ public class CacheAccess<K, V>
}
/**
- * Get multiple elements from the cache based on a set of cache keys.
+ * Gets multiple elements from the cache based on a set of cache keys.
* <p>
* This method returns the ICacheElement<K, V> wrapper which
provides access to element info and other
* attributes.
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 5d1808e1..3803f61a 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
@@ -108,7 +108,7 @@ public interface ICacheAccess<K, V>
ICacheElement<K, V> getCacheElement(K name);
/**
- * Get multiple elements from the cache based on a set of cache keys.
+ * Gets multiple elements from the cache based on a set of cache keys.
* <p>
* This method returns the ICacheElement<K, V> wrapper which
provides access to element info and other
* attributes.
@@ -128,7 +128,7 @@ public interface ICacheAccess<K, V>
Map<K, ICacheElement<K, V>> getCacheElements(Set<K> names);
/**
- * Get multiple elements from the cache based on a set of cache keys.
+ * Gets multiple elements from the cache based on a set of cache keys.
* <p>
* This method returns the ICacheElement<K, V> wrapper which
provides access to element info and other
* attributes.
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/AuxiliaryCache.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/AuxiliaryCache.java
index 72ab8ce1..d18da8a7 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/AuxiliaryCache.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/AuxiliaryCache.java
@@ -37,7 +37,7 @@ public interface AuxiliaryCache<K, V>
extends ICache<K, V>
{
/**
- * Get a set of the keys for all elements in the auxiliary cache.
+ * Gets a set of the keys for all elements in the auxiliary cache.
* <p>
* @return a set of the key type
* TODO This should probably be done in chunks with a range passed in. This
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/AbstractDiskCache.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/AbstractDiskCache.java
index c3494f2f..296339e0 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/AbstractDiskCache.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/AbstractDiskCache.java
@@ -676,7 +676,7 @@ public abstract class AbstractDiskCache<K, V>
*/
/**
- * Get a value from the persistent store.
+ * Gets a value from the persistent store.
*
* Before the event logging layer, the subclasses implemented the do*
methods. Now the do*
* methods call the *EventLogging method on the super. The
*WithEventLogging methods call the
@@ -693,7 +693,7 @@ public abstract class AbstractDiskCache<K, V>
}
/**
- * Get a value from the persistent store.
+ * Gets a value from the persistent store.
*
* Before the event logging layer, the subclasses implemented the do*
methods. Now the do*
* methods call the *EventLogging method on the super. The
*WithEventLogging methods call the
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/AbstractDiskCacheAttributes.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/AbstractDiskCacheAttributes.java
index 4aa4c6c1..b0ca8d67 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/AbstractDiskCacheAttributes.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/AbstractDiskCacheAttributes.java
@@ -131,7 +131,7 @@ public abstract class AbstractDiskCacheAttributes extends
AbstractAuxiliaryCache
}
/**
- * Get the amount of time in seconds we will wait for elements to move to
disk during shutdown
+ * Gets the amount of time in seconds we will wait for elements to move to
disk during shutdown
* for a particular region.
* <p>
*
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/PurgatoryElement.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/PurgatoryElement.java
index a8637834..f6a8cc34 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/PurgatoryElement.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/PurgatoryElement.java
@@ -73,7 +73,7 @@ public class PurgatoryElement<K, V>
}
/**
- * Get the wrapped cache element.
+ * Gets the wrapped cache element.
*
* @return ICacheElement
*/
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/behavior/IDiskCacheAttributes.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/behavior/IDiskCacheAttributes.java
index 7d52feff..4e2c0973 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/behavior/IDiskCacheAttributes.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/behavior/IDiskCacheAttributes.java
@@ -73,7 +73,7 @@ public interface IDiskCacheAttributes
void setMaxPurgatorySize( int maxPurgatorySize );
/**
- * Get the amount of time in seconds we will wait for elements to move to
+ * Gets the amount of time in seconds we will wait for elements to move to
* disk during shutdown for a particular region.
* <p>
* @return the time in seconds.
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
index e227efc5..847d1c43 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/disk/jdbc/JDBCDiskCacheFactory.java
@@ -141,7 +141,7 @@ public class JDBCDiskCacheFactory
}
/**
- * Get a table state for a given table name
+ * Gets a table state for a given table name
*
* @param tableName
* @return a cached instance of the table state
@@ -161,7 +161,7 @@ public class JDBCDiskCacheFactory
}
/**
- * Get the scheduler service
+ * Gets the scheduler service
*
* @return the scheduler
*/
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
index 820caff1..3bed4281 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
@@ -280,7 +280,7 @@ public abstract class AbstractRemoteCacheNoWaitFacade<K, V>
protected abstract void failover( RemoteCacheNoWait<K, V> rcnw );
/**
- * Get the primary server from the list of failovers
+ * Gets the primary server from the list of failovers
*
* @return a no wait
*/
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 2d2ccfe7..3453e94d 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
@@ -113,7 +113,7 @@ public class RemoteCache<K, V>
}
/**
- * Get facade
+ * Gets facade
*
* @return the facade
*/
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteUtils.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteUtils.java
index e04314ed..ed3e9e3e 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteUtils.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/RemoteUtils.java
@@ -226,7 +226,7 @@ public class RemoteUtils
}
/**
- * Get the naming url used for RMI registration
+ * Gets the naming url used for RMI registration
*
* @param location
* the remote location
@@ -240,7 +240,7 @@ public class RemoteUtils
}
/**
- * Get the naming url used for RMI registration
+ * Gets the naming url used for RMI registration
*
* @param registryHost
* the remote host
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 bac58de2..41721255 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
@@ -32,7 +32,7 @@ public interface IRemoteCacheListener<K, V>
extends ICacheListener<K, V>, Remote
{
/**
- * Get the id to be used by this manager.
+ * Gets the id to be used by this manager.
* <p>
* @return long
* @throws IOException
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/server/RemoteHttpCacheServlet.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/server/RemoteHttpCacheServlet.java
index f80083ec..a81d345c 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/server/RemoteHttpCacheServlet.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/http/server/RemoteHttpCacheServlet.java
@@ -342,7 +342,7 @@ public class RemoteHttpCacheServlet
}
/**
- * Get servlet information
+ * Gets servlet information
* <p>
* @return basic info
*/
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServer.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServer.java
index 97f13375..3206771f 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServer.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/server/RemoteCacheServer.java
@@ -64,7 +64,7 @@ import org.apache.commons.jcs3.utils.timing.ElapsedTimer;
* broadcast such event to their client, then remove an puts can be sent to
all locals in the
* cluster.
* <p>
- * Get requests are made between clustered servers if AllowClusterGet is true.
You can setup several
+ * Gets requests are made between clustered servers if AllowClusterGet is
true. You can setup several
* clients to use one remote server and several to use another. The get local
will be distributed
* between the two servers. Since caches are usually high get and low put,
this should allow you to
* scale.
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/value/RemoteRequestType.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/value/RemoteRequestType.java
index 6a81e0dd..5302a669 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/value/RemoteRequestType.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/auxiliary/remote/value/RemoteRequestType.java
@@ -27,13 +27,13 @@ public enum RemoteRequestType
/** Alive check request type. */
ALIVE_CHECK,
- /** Get request type. */
+ /** Gets request type. */
GET,
- /** Get Multiple request type. */
+ /** Gets Multiple request type. */
GET_MULTIPLE,
- /** Get Matching request type. */
+ /** Gets Matching request type. */
GET_MATCHING,
/** Update request type. */
@@ -45,7 +45,7 @@ public enum RemoteRequestType
/** Remove All request type. */
REMOVE_ALL,
- /** Get keys request type. */
+ /** Gets keys request type. */
GET_KEYSET,
/** Dispose request type. */
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/ICacheServiceNonLocal.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/ICacheServiceNonLocal.java
index 82041afb..242e9b26 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/ICacheServiceNonLocal.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/ICacheServiceNonLocal.java
@@ -106,7 +106,7 @@ public interface ICacheServiceNonLocal<K, V>
throws IOException;
/**
- * Get a set of the keys for all elements in the cache.
+ * Gets a set of the keys for all elements in the cache.
* <p>
* @param cacheName the name of the cache
* @return a set of the key type
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IProvideScheduler.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IProvideScheduler.java
index 926ed3c6..aabda0cd 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IProvideScheduler.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/behavior/IProvideScheduler.java
@@ -28,7 +28,7 @@ import java.util.concurrent.ScheduledExecutorService;
public interface IProvideScheduler
{
/**
- * Get an instance of a central ScheduledExecutorService
+ * Gets an instance of a central ScheduledExecutorService
* @return the central scheduler
*/
ScheduledExecutorService getScheduledExecutorService();
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCache.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCache.java
index c2ed60e7..56b8f9f1 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCache.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/control/CompositeCache.java
@@ -207,7 +207,7 @@ public class CompositeCache<K, V>
}
/**
- * Get the list of auxiliary caches for this region.
+ * Gets the list of auxiliary caches for this region.
* <p>
* @return a list of auxiliary caches, may be empty, never null
* @since 3.1
@@ -959,7 +959,7 @@ public class CompositeCache<K, V>
}
/**
- * Get a set of the keys for all elements in the cache
+ * Gets a set of the keys for all elements in the cache
* <p>
* @return A set of the key type
*/
@@ -969,7 +969,7 @@ public class CompositeCache<K, V>
}
/**
- * Get a set of the keys for all elements in the cache
+ * Gets a set of the keys for all elements in the cache
* <p>
* @param localOnly true if only memory keys are requested
*
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 1551bc70..ef4d2d00 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
@@ -158,7 +158,7 @@ public class CompositeCacheConfigurator
}
/**
- * Get all the properties for a region and configure its cache.
+ * Gets all the properties for a region and configure its cache.
* <p>
* This method tells the other parse method the name of the region prefix.
*<p>
@@ -178,7 +178,7 @@ public class CompositeCacheConfigurator
}
/**
- * Get all the properties for a region and configure its cache.
+ * Gets all the properties for a region and configure its cache.
*<p>
* @param props Configuration properties
* @param ccm Cache hub
@@ -266,7 +266,7 @@ public class CompositeCacheConfigurator
}
/**
- * Get an ICompositeCacheAttributes for the listed region.
+ * Gets an ICompositeCacheAttributes for the listed region.
*<p>
* @param props Configuration properties
* @param regName the region name
@@ -281,7 +281,7 @@ public class CompositeCacheConfigurator
}
/**
- * Get the main attributes for a region.
+ * Gets the main attributes for a region.
*<p>
* @param props Configuration properties
* @param regName the region name
@@ -362,7 +362,7 @@ public class CompositeCacheConfigurator
}
/**
- * Get an aux cache for the listed aux for a region.
+ * Gets an aux cache for the listed aux for a region.
*<p>
* @param props the configuration properties
* @param ccm Cache hub
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 4391e73b..197b3b26 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
@@ -194,7 +194,7 @@ public class CompositeCacheManager
}
/**
- * Get a CacheHub instance which is not configured. If an instance already
exists, it will be
+ * Gets a CacheHub instance which is not configured. If an instance
already exists, it will be
* returned.
*
* @return CompositeCacheManager
@@ -282,7 +282,7 @@ public class CompositeCacheManager
}
/**
- * Get the element event queue
+ * Gets the element event queue
*
* @return the elementEventQueue
*/
@@ -292,7 +292,7 @@ public class CompositeCacheManager
}
/**
- * Get the scheduler service
+ * Gets the scheduler service
*
* @return the scheduledExecutor
*/
@@ -770,7 +770,7 @@ public class CompositeCacheManager
}
/**
- * Get a cache from the map of registered auxiliary caches
+ * Gets a cache from the map of registered auxiliary caches
*
* @param auxName the auxiliary name
* @param cacheName the region name
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/AbstractMemoryCache.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/AbstractMemoryCache.java
index e08ac99e..4091f7c3 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/AbstractMemoryCache.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/AbstractMemoryCache.java
@@ -140,7 +140,7 @@ public abstract class AbstractMemoryCache<K, V>
}
/**
- * Get an item from the cache without affecting its last access time or
position. Not all memory
+ * Gets an item from the cache without affecting its last access time or
position. Not all memory
* cache implementations can get quietly.
* <p>
* @param key Identifies item to find
@@ -446,7 +446,7 @@ public abstract class AbstractMemoryCache<K, V>
}
/**
- * Get a set of the keys for all elements in the memory cache
+ * Gets a set of the keys for all elements in the memory cache
*
* @return a set of keys
*/
@@ -457,7 +457,7 @@ public abstract class AbstractMemoryCache<K, V>
}
/**
- * Get an item from the cache.
+ * Gets an item from the cache.
* <p>
*
* @param key Identifies item to find
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/behavior/IMemoryCache.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/behavior/IMemoryCache.java
index d41dc684..cebbd1aa 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/behavior/IMemoryCache.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/behavior/IMemoryCache.java
@@ -47,7 +47,7 @@ public interface IMemoryCache<K, V>
throws IOException;
/**
- * Get the number of elements contained in the memory store
+ * Gets the number of elements contained in the memory store
* <p>
* @return Element count
*/
@@ -61,7 +61,7 @@ public interface IMemoryCache<K, V>
IStats getStatistics();
/**
- * Get a set of the keys for all elements in the memory cache.
+ * Gets a set of the keys for all elements in the memory cache.
* <p>
* @return a set of the key type
* TODO This should probably be done in chunks with a range passed in. This
@@ -106,7 +106,7 @@ public interface IMemoryCache<K, V>
throws IOException;
/**
- * Get an item from the cache
+ * Gets an item from the cache
* <p>
* @param key
* Description of the Parameter
@@ -129,7 +129,7 @@ public interface IMemoryCache<K, V>
throws IOException;
/**
- * Get an item from the cache without effecting its order or last access
+ * Gets an item from the cache without effecting its order or last access
* time
* <p>
* @param key
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/util/MemoryElementDescriptor.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/util/MemoryElementDescriptor.java
index cc1f5fc2..380dccea 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/util/MemoryElementDescriptor.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/engine/memory/util/MemoryElementDescriptor.java
@@ -42,7 +42,7 @@ public class MemoryElementDescriptor<K, V>
}
/**
- * Get the cache element
+ * Gets the cache element
*
* @return the ce
*/
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 3188a334..a26c88a7 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
@@ -49,7 +49,7 @@ public class StatElement<V>
}
/**
- * Get the name of the stat element, for example, HitCount
+ * Gets the name of the stat element, for example, HitCount
* <p>
* @return the stat element name
*/
@@ -69,7 +69,7 @@ public class StatElement<V>
}
/**
- * Get the data, for example, for hit count you would get a value for some
number.
+ * Gets the data, for example, for hit count you would get a value for
some number.
* <p>
* @return 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 44e8ed5f..a9f4b6df 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
@@ -27,7 +27,7 @@ import java.io.Serializable;
public interface IStatElement<V> extends Serializable
{
/**
- * Get the name of the stat element, for example, HitCount
+ * Gets the name of the stat element, for example, HitCount
* <p>
* @return the stat element name
*/
@@ -39,7 +39,7 @@ public interface IStatElement<V> extends Serializable
void setName( String name );
/**
- * Get the data, for example, for hit count you would get a value for some
number.
+ * Gets the data, for example, for hit count you would get a value for
some number.
* <p>
* @return 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 c7431fc7..a11a2943 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
@@ -44,7 +44,7 @@ public interface IStats
void setStatElements( List<IStatElement<?>> stats );
/**
- * Get the type name, such as "LRU Memory Cache." No formal type is
defined.
+ * Gets the type name, such as "LRU Memory Cache." No formal type is
defined.
*
* @return String
*/
diff --git
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java
index 028a8c4a..3807d776 100644
---
a/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java
+++
b/commons-jcs3-core/src/main/java/org/apache/commons/jcs3/utils/discovery/UDPDiscoveryService.java
@@ -380,7 +380,7 @@ public class UDPDiscoveryService
}
/**
- * Get all the cache names we have facades for.
+ * Gets all the cache names we have facades for.
* <p>
* @return ArrayList
*/
diff --git
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/memory/lru/LHMLRUMemoryCacheUnitTest.java
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/memory/lru/LHMLRUMemoryCacheUnitTest.java
index b50aa132..c9f564be 100644
---
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/memory/lru/LHMLRUMemoryCacheUnitTest.java
+++
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/memory/lru/LHMLRUMemoryCacheUnitTest.java
@@ -222,7 +222,7 @@ public class LHMLRUMemoryCacheUnitTest
}
/**
- * Get stats.
+ * Gets stats.
* <p>
* @throws CacheException
*/
diff --git
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/memory/mru/MRUMemoryCacheUnitTest.java
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/memory/mru/MRUMemoryCacheUnitTest.java
index e80c89c0..c20f807a 100644
---
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/memory/mru/MRUMemoryCacheUnitTest.java
+++
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/engine/memory/mru/MRUMemoryCacheUnitTest.java
@@ -222,7 +222,7 @@ public class MRUMemoryCacheUnitTest
}
/**
- * Get stats.
+ * Gets stats.
* <p>
* @throws CacheException
*/
diff --git
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/threadpool/ThreadPoolManagerUnitTest.java
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/threadpool/ThreadPoolManagerUnitTest.java
index dd0ac30a..0971f9a3 100644
---
a/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/threadpool/ThreadPoolManagerUnitTest.java
+++
b/commons-jcs3-core/src/test/java/org/apache/commons/jcs3/utils/threadpool/ThreadPoolManagerUnitTest.java
@@ -67,7 +67,7 @@ public class ThreadPoolManagerUnitTest
}
/**
- * Get a couple pools by name and then see if they are in the list.
+ * Gets a couple pools by name and then see if they are in the list.
*
*/
@Test
diff --git
a/commons-jcs3-sandbox/commons-jcs3-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCacheManager.java
b/commons-jcs3-sandbox/commons-jcs3-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCacheManager.java
index 753cd78d..2e7e21e3 100644
---
a/commons-jcs3-sandbox/commons-jcs3-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCacheManager.java
+++
b/commons-jcs3-sandbox/commons-jcs3-filecache/src/main/java/org/apache/commons/jcs/auxiliary/disk/file/FileDiskCacheManager.java
@@ -100,7 +100,7 @@ public class FileDiskCacheManager
}
/**
- * Get an DiskFileCache for the supplied attributes. Will provide an
existing cache for the name
+ * Gets an DiskFileCache for the supplied attributes. Will provide an
existing cache for the name
* attribute if one has been created, or will create a new cache.
* <p>
* @param cacheAttributes Attributes the cache should have.
diff --git
a/src/experimental/org/apache/commons/jcs/auxiliary/lateral/http/server/LateralCacheServletReciever.java
b/src/experimental/org/apache/commons/jcs/auxiliary/lateral/http/server/LateralCacheServletReciever.java
index 5fb27638..644a7434 100644
---
a/src/experimental/org/apache/commons/jcs/auxiliary/lateral/http/server/LateralCacheServletReciever.java
+++
b/src/experimental/org/apache/commons/jcs/auxiliary/lateral/http/server/LateralCacheServletReciever.java
@@ -182,7 +182,7 @@ public class LateralCacheServletReciever
cacheMgr.release();
}
- /** Get servlet information */
+ /** Gets servlet information */
public String getServletInfo()
{
return "LateralCacheServlet v1";
diff --git
a/src/experimental/org/apache/commons/jcs/engine/memory/arc/ARCMemoryCache.java
b/src/experimental/org/apache/commons/jcs/engine/memory/arc/ARCMemoryCache.java
index f1754dc7..80dd0ec6 100644
---
a/src/experimental/org/apache/commons/jcs/engine/memory/arc/ARCMemoryCache.java
+++
b/src/experimental/org/apache/commons/jcs/engine/memory/arc/ARCMemoryCache.java
@@ -101,7 +101,7 @@ public class ARCMemoryCache
}
/**
- * Get an Array of the keys for all elements in the memory cache
+ * Gets an Array of the keys for all elements in the memory cache
* @return Object[]
*/
public Object[] getKeyArray()
