I have three patches that might be helpful...
1. Javadoc changes to make it compile on my machine
2. Server port changes which may (or may not) fix the continuum unit test
issue
3. Change to the way existing tables are detected (I think I got a
different SQL error code)
Many thanks,
Mat.
On Tue, 2 Feb 2016 at 17:12 Thomas Vandahl <[email protected]> wrote:
> On 02.02.16 11:22, Mat Jaggard wrote:
> > I've submitted my pull request.
> >
> > https://github.com/apache/commons-jcs/pull/2
> >
> > On Mon, 1 Feb 2016 at 16:32 Gary Gregory <[email protected]> wrote:
> >
> >> It is, github is just a mirror. You submit a patch with the Jira if you
> >> prefer.
>
> Thanks for your contribution. How do I merge this into SVN now? I'm not
> familiar with github.
>
> Bye, Thomas
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [email protected]
> For additional commands, e-mail: [email protected]
>
>
Index: java/org/apache/commons/jcs/auxiliary/remote/server/BasicRemoteCacheClientServerUnitTest.java
===================================================================
--- java/org/apache/commons/jcs/auxiliary/remote/server/BasicRemoteCacheClientServerUnitTest.java (revision 1726611)
+++ java/org/apache/commons/jcs/auxiliary/remote/server/BasicRemoteCacheClientServerUnitTest.java (working copy)
@@ -46,7 +46,7 @@
/**
* These tests startup the remote server and make requests to it.
- * <p/>
+ * <p>
*
* @author Aaron Smuts
*/
@@ -53,7 +53,9 @@
@FixMethodOrder(MethodSorters.NAME_ASCENDING)
public class BasicRemoteCacheClientServerUnitTest extends Assert
{
- /**
+ private static final int LOCAL_PORT = 12020;
+
+ /**
* Server instance to use in the tests.
*/
private static RemoteCacheServer<String, String> server = null;
@@ -124,12 +126,12 @@
* Verify that we can start the remote cache server. Send an item to the remote. Verify that the
* remote put count goes up. If we go through JCS, the manager will be shared and we will get
* into an endless loop. We will use a mock cache manager instead.
- * <p/>
+ * <p>
* The remote server uses the real JCS. We can verify that items are added to JCS behind the
* server by calling get. We cannot access it directly via JCS since it is serialized.
- * <p/>
+ * <p>
* This test uses a mock injected client to test a normal server.
- * <p/>
+ * <p>
*
* @throws Exception
*/
@@ -142,7 +144,7 @@
RemoteCacheAttributes attributes = new RemoteCacheAttributes();
attributes.setRemoteLocation("localhost", remotePort);
- attributes.setLocalPort(1202);
+ attributes.setLocalPort(LOCAL_PORT);
RemoteCacheManager remoteCacheManager = RemoteCacheFactory.getManager(attributes, compositeCacheManager, new MockCacheEventLogger(), new MockElementSerializer());
String regionName = "testSinglePut";
@@ -176,7 +178,7 @@
/**
* Verify that we can remove an item via the remote server.
- * <p/>
+ * <p>
*
* @throws Exception
*/
@@ -189,7 +191,7 @@
RemoteCacheAttributes attributes = new RemoteCacheAttributes();
attributes.setRemoteLocation("localhost", remotePort);
- attributes.setLocalPort(1202);
+ attributes.setLocalPort(LOCAL_PORT);
MockCacheEventLogger cacheEventLogger = new MockCacheEventLogger();
@@ -245,7 +247,7 @@
RemoteCacheAttributes attributes = new RemoteCacheAttributes();
attributes.setRemoteLocation("localhost", remotePort);
- attributes.setLocalPort(1202);
+ attributes.setLocalPort(LOCAL_PORT);
RemoteCacheManager remoteCacheManager = RemoteCacheFactory.getManager(attributes, compositeCacheManager, new MockCacheEventLogger(), new MockElementSerializer());
String regionName = "testPutAndListen";
@@ -294,7 +296,7 @@
RemoteCacheAttributes attributes = new RemoteCacheAttributes();
attributes.setRemoteLocation("localhost", remotePort);
- attributes.setLocalPort(1202);
+ attributes.setLocalPort(LOCAL_PORT);
RemoteCacheManager remoteCacheManager = RemoteCacheFactory.getManager(attributes, compositeCacheManager, new MockCacheEventLogger(), new MockElementSerializer());
String regionName = "testPutaMultipleAndListen";
Index: test-conf/TestRemoteCacheClientServer.ccf
===================================================================
--- test-conf/TestRemoteCacheClientServer.ccf (revision 1726611)
+++ test-conf/TestRemoteCacheClientServer.ccf (working copy)
@@ -18,10 +18,10 @@
# ################# REMOTE SERVER CONFIG #####################
# Registry used to register and provide the IRmiCacheService service.
registry.host=localhost
-registry.port=1102
+registry.port=11020
# client callback port.
-remote.cache.service.port=1301
+remote.cache.service.port=13010
remote.cache.rmiSocketFactoryTimeoutMillis=12345
# cluster setting
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/jdbc/mysql/MySQLDiskCacheHsqlBackedUnitTest.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/jdbc/mysql/MySQLDiskCacheHsqlBackedUnitTest.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/jdbc/mysql/MySQLDiskCacheHsqlBackedUnitTest.java (working copy)
@@ -207,7 +207,7 @@
}
catch ( SQLException e )
{
- if ("23000".equals(e.getSQLState()))
+ if ("23000".equals(e.getSQLState()) || "S0001".equals(e.getSQLState()))
{
newT = false;
}
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/jdbc/JDBCDiskCacheShrinkUnitTest.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/jdbc/JDBCDiskCacheShrinkUnitTest.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/jdbc/JDBCDiskCacheShrinkUnitTest.java (working copy)
@@ -254,7 +254,7 @@
}
catch ( SQLException e )
{
- if ("23000".equals(e.getSQLState()))
+ if ("23000".equals(e.getSQLState()) || "S0001".equals(e.getSQLState()))
{
newT = false;
}
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/jdbc/HsqlSetupTableUtil.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/jdbc/HsqlSetupTableUtil.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/jdbc/HsqlSetupTableUtil.java (working copy)
@@ -60,7 +60,7 @@
}
catch ( SQLException e )
{
- if ("23000".equals(e.getSQLState()))
+ if ("23000".equals(e.getSQLState()) || "S0001".equals(e.getSQLState()))
{
newT = false;
}
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/utils/threadpool/ThreadPoolUnitTest.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/utils/threadpool/ThreadPoolUnitTest.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/utils/threadpool/ThreadPoolUnitTest.java (working copy)
@@ -37,8 +37,7 @@
* <p>
* We just want to ensure that we can adjust the max size of an active pool.
* <p>
- * http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/PooledExecutor.html#
- * setMaximumPoolSize(int) p>
+ * http://gee.cs.oswego.edu/dl/classes/EDU/oswego/cs/dl/util/concurrent/PooledExecutor.html#setMaximumPoolSize(int)
* @throws Exception
*/
public void testMaxReduction()
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/utils/serialization/CompressingSerializerUnitTest.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/utils/serialization/CompressingSerializerUnitTest.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/utils/serialization/CompressingSerializerUnitTest.java (working copy)
@@ -51,7 +51,7 @@
/**
* Test simple back and forth with a string.
* <p>
- * ))<=>((
+ * ))<=>((
* <p>
* @throws Exception on error
*/
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/engine/control/CompositeCacheDiskUsageUnitTest.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/engine/control/CompositeCacheDiskUsageUnitTest.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/engine/control/CompositeCacheDiskUsageUnitTest.java (working copy)
@@ -361,7 +361,7 @@
* Gets multiple items from the cache based on the given set of keys.
* <p>
* @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
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/engine/SystemPropertyUsageUnitTest.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/engine/SystemPropertyUsageUnitTest.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/engine/SystemPropertyUsageUnitTest.java (working copy)
@@ -20,6 +20,7 @@
*/
import junit.framework.TestCase;
+
import org.apache.commons.jcs.JCS;
import org.apache.commons.jcs.access.CacheAccess;
import org.apache.commons.jcs.engine.control.CompositeCacheManager;
@@ -37,6 +38,15 @@
private static final int testValue = 6789;
private CompositeCacheManager manager = null;
+
+ @Override
+ protected void setUp() throws Exception
+ {
+ super.setUp();
+ //First shut down any previously running manager.
+ manager = CompositeCacheManager.getInstance();
+ manager.shutDown();
+ }
/**
* @see junit.framework.TestCase#tearDown()
@@ -62,14 +72,14 @@
throws Exception
{
System.setProperty( JCS_DEFAULT_CACHEATTRIBUTES_MAX_OBJECTS, String.valueOf(testValue) );
-
+
JCS.setConfigFilename( "/TestSystemPropertyUsage.ccf" );
-
+
CacheAccess<String, String> jcs = JCS.getInstance( "someCacheNotInFile" );
manager = CompositeCacheManager.getInstance();
- assertEquals( "System property value is not reflected", testValue, jcs.getCacheAttributes().getMaxObjects());
+ assertEquals( "System property value is not reflected.", testValue, jcs.getCacheAttributes().getMaxObjects());
}
/**
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/remote/MockRemoteCacheService.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/remote/MockRemoteCacheService.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/remote/MockRemoteCacheService.java (working copy)
@@ -99,10 +99,6 @@
/**
* Set the lastRemoveAllCacheName to the cacheName.
- * <p>
- * (non-Javadoc)
- * @see org.apache.commons.jcs.auxiliary.remote.behavior.ICacheServiceNonLocal#removeAll(java.lang.String,
- * long)
*/
@Override
public void removeAll( String cacheName, long requesterId )
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/remote/MockRemoteCacheClient.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/remote/MockRemoteCacheClient.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/remote/MockRemoteCacheClient.java (working copy)
@@ -50,7 +50,7 @@
/** log instance */
private static final Log log = LogFactory.getLog( MockRemoteCacheClient.class );
- /** List of ICacheElement<K, V> objects passed into update. */
+ /** List of ICacheElement<K, V> objects passed into update. */
public List<ICacheElement<K, V>> updateList = new LinkedList<ICacheElement<K,V>>();
/** List of key objects passed into remove. */
@@ -59,10 +59,10 @@
/** status to return. */
public CacheStatus status = CacheStatus.ALIVE;
- /** Can setup values to return from get. values must be ICacheElement<K, V> */
+ /** Can setup values to return from get. values must be ICacheElement<K, V> */
public Map<K, ICacheElement<K, V>> getSetupMap = new HashMap<K, ICacheElement<K,V>>();
- /** Can setup values to return from get. values must be Map<K, ICacheElement<K, V>> */
+ /** Can setup values to return from get. values must be Map<K, ICacheElement<K, V>> */
public Map<Set<K>, Map<K, ICacheElement<K, V>>> getMultipleSetupMap =
new HashMap<Set<K>, Map<K,ICacheElement<K,V>>>();
@@ -74,8 +74,6 @@
/**
* Stores the last argument as fixed.
- * <p>
- * @see org.apache.commons.jcs.auxiliary.remote.behavior.IRemoteCacheClient#fixCache(org.apache.commons.jcs.engine.behavior.ICacheServiceNonLocal)
*/
@Override
@SuppressWarnings("unchecked") // Don't know how to do this properly
@@ -104,9 +102,6 @@
/**
* Adds the argument to the updatedList.
- * <p>
- * (non-Javadoc)
- * @see org.apache.commons.jcs.auxiliary.AuxiliaryCache#update(org.apache.commons.jcs.engine.behavior.ICacheElement)
*/
@Override
public void update( ICacheElement<K, V> ce )
@@ -116,9 +111,6 @@
/**
* Looks in the getSetupMap for a value.
- * <p>
- * (non-Javadoc)
- * @see org.apache.commons.jcs.auxiliary.AuxiliaryCache#get(java.io.Serializable)
*/
@Override
public ICacheElement<K, V> get( K key )
@@ -131,7 +123,7 @@
* Gets multiple items from the cache based on the given set of keys.
* <p>
* @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
@@ -143,9 +135,6 @@
/**
* Adds the key to the remove list.
- * <p>
- * (non-Javadoc)
- * @see org.apache.commons.jcs.auxiliary.AuxiliaryCache#remove(java.io.Serializable)
*/
@Override
public boolean remove( K key )
@@ -184,8 +173,7 @@
}
/**
- * Returns the status setup variable. (non-Javadoc)
- * @see org.apache.commons.jcs.auxiliary.AuxiliaryCache#getStatus()
+ * Returns the status setup variable.
*/
@Override
public CacheStatus getStatus()
@@ -224,9 +212,6 @@
/**
* Returns the setup attributes. By default they are not null.
- * <p>
- * (non-Javadoc)
- * @see org.apache.commons.jcs.auxiliary.AuxiliaryCache#getAuxiliaryCacheAttributes()
*/
@Override
public AuxiliaryCacheAttributes getAuxiliaryCacheAttributes()
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/block/HugeQuantityBlockDiskCacheLoadTest.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/block/HugeQuantityBlockDiskCacheLoadTest.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/block/HugeQuantityBlockDiskCacheLoadTest.java (working copy)
@@ -26,7 +26,7 @@
import org.apache.commons.jcs.utils.timing.SleepUtil;
/**
- * Put a few hundred thousand entries in the block disk cache. <p.
+ * Put a few hundred thousand entries in the block disk cache.
* @author Aaron Smuts
*/
public class HugeQuantityBlockDiskCacheLoadTest
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCacheUnitTestAbstract.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCacheUnitTestAbstract.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCacheUnitTestAbstract.java (working copy)
@@ -32,13 +32,6 @@
/** Unit tests for the Block Disk Cache */
public abstract class BlockDiskCacheUnitTestAbstract extends TestCase
{
- /**
- * Test the basic get matching.
- * <p>
- *
- * @throws Exception
- */
-
public abstract BlockDiskCacheAttributes getCacheAttributes();
public void testPutGetMatching_SmallWait() throws Exception
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCacheRandomConcurrentTestUtil.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCacheRandomConcurrentTestUtil.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCacheRandomConcurrentTestUtil.java (working copy)
@@ -20,9 +20,11 @@
*/
import junit.framework.TestCase;
+
import org.apache.commons.jcs.JCS;
import org.apache.commons.jcs.access.CacheAccess;
import org.apache.commons.jcs.access.TestCacheAccess;
+import org.junit.Test;
/**
* This is used by other tests to generate a random load on the disk cache.
@@ -39,6 +41,12 @@
{
super( testName );
}
+
+ @Test
+ public void test()
+ {
+
+ }
/**
* Randomly adds items to cache, gets them, and removes them. The range
Index: commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/MockAuxiliaryCache.java
===================================================================
--- commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/MockAuxiliaryCache.java (revision 1726611)
+++ commons-jcs-core/src/test/java/org/apache/commons/jcs/auxiliary/MockAuxiliaryCache.java (working copy)
@@ -87,7 +87,7 @@
* Gets multiple items from the cache based on the given set of keys.
* <p>
* @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
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/utils/struct/BoundedQueue.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/utils/struct/BoundedQueue.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/utils/struct/BoundedQueue.java (working copy)
@@ -83,9 +83,9 @@
}
/**
- * Return true if the size is <= 0;
+ * Return true if the size is <= 0;
* <p>
- * @return true is size <= 0;
+ * @return true is size <= 0;
*/
public boolean isEmpty()
{
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/utils/net/HostNameUtil.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/utils/net/HostNameUtil.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/utils/net/HostNameUtil.java (working copy)
@@ -78,10 +78,12 @@
* multiple IP addresses, this method will prefer a site-local IP address (e.g. 192.168.x.x or
* 10.10.x.x, usually IPv4) if the machine has one (and will return the first site-local address
* if the machine has more than one), but if the machine does not hold a site-local address,
- * this method will return simply the first non-loopback address found (IPv4 or IPv6). <p/> If
- * this method cannot find a non-loopback address using this selection algorithm, it will fall
- * back to calling and returning the result of JDK method <code>InetAddress.getLocalHost</code>.
+ * this method will return simply the first non-loopback address found (IPv4 or IPv6).</p>
* <p>
+ * If this method cannot find a non-loopback address using this selection algorithm, it will
+ * fall back to calling and returning the result of JDK method
+ * <code>InetAddress.getLocalHost</code>.
+ * <p>
* <a href="http://issues.apache.org/jira/browse/JCS-40";>JIR ISSUE JCS-40</a>
* <p>
* @return InetAddress
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/utils/config/OptionConverter.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/utils/config/OptionConverter.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/utils/config/OptionConverter.java (working copy)
@@ -71,7 +71,7 @@
/**
* Escapes special characters.
- * <p>
+ *
* @param s
* @return String
*/
@@ -152,7 +152,7 @@
/**
* Creates an object for the className value of the key.
- * <p>
+ *
* @param props
* @param key
* @param defaultValue
@@ -178,7 +178,7 @@
/**
* If <code>value</code> is "true", then <code>true</code> is returned. If <code>value</code> is
* "false", then <code>true</code> is returned. Otherwise, <code>default</code> is returned.
- * <p>
+ *
* Case of value is unimportant.
* @param value
* @param defaultValue
@@ -204,7 +204,7 @@
/**
* Converts to int.
- * <p>
+ *
* @param value
* @param defaultValue
* @return int
@@ -276,7 +276,7 @@
/**
* Find the value corresponding to <code>key</code> in <code>props</code>. Then perform variable
* substitution on the found value.
- * <p>
+ *
* @param key
* @param props
* @return substituted string
@@ -305,7 +305,7 @@
* Instantiate an object given a class name. Check that the <code>className</code> is a subclass
* of <code>superClass</code>. If that test fails or the object could not be instantiated, then
* <code>defaultValue</code> is returned.
- * <p>
+ *
* @param className The fully qualified class name of the object to instantiate.
* @param defaultValue The object to return in case of non-fulfillment
* @return instantiated object
@@ -343,9 +343,9 @@
/**
* Perform variable substitution in string <code>val</code> from the values of keys found in the
* system properties.
- * <p>
+ *
* The variable substitution delimiters are <b>${ </b> and <b>} </b>.
- * <p>
+ *
* For example, if the System properties contains "key=value", then the call
*
* <pre>
@@ -353,11 +353,11 @@
* </pre>
*
* will set the variable <code>s</code> to "Value of key is value.".
- * <p>
+ *
* If no value could be found for the specified key, then the <code>props</code> parameter is
* searched, if the value could not be found there, then substitution defaults to the empty
* string.
- * <p>
+ *
* For example, if system properties contains no value for the key "inexistentKey", then the call
*
* <pre>
@@ -370,7 +370,7 @@
* delimiter "${" which is not balanced by a stop delimiter "}".
* </p>
* <p>
- * <b>Author </b> Avy Sharell </a>
+ * <b>Author </b> Avy Sharell
* </p>
* @param val The string on which variable substitution is performed.
* @param props
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/lru/LRUMemoryCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/lru/LRUMemoryCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/lru/LRUMemoryCache.java (working copy)
@@ -34,7 +34,7 @@
* might want to find a more efficient memory manager for large cache regions.
* <p>
* The LRUMemoryCache is most efficient when the first element is selected. The smaller the region,
- * the better the chance that this will be the case. < .04 ms per put, p3 866, 1/10 of that per get
+ * the better the chance that this will be the case. < .04 ms per put, p3 866, 1/10 of that per get
*/
public class LRUMemoryCache<K, V>
extends AbstractDoubleLinkedListMemoryCache<K, V>
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/lru/LHMLRUMemoryCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/lru/LHMLRUMemoryCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/lru/LHMLRUMemoryCache.java (working copy)
@@ -119,7 +119,7 @@
* Get an item from the cache
* <p>
* @param key Identifies item to find
- * @return ICacheElement<K, V> if found, else null
+ * @return ICacheElement<K, V> if found, else null
* @throws IOException
*/
@Override
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/behavior/IMemoryCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/behavior/IMemoryCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/behavior/IMemoryCache.java (working copy)
@@ -121,7 +121,7 @@
* Gets multiple items from the cache based on the given set of keys.
* <p>
* @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
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/AbstractMemoryCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/AbstractMemoryCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/AbstractMemoryCache.java (working copy)
@@ -128,7 +128,7 @@
* Gets multiple items from the cache based on the given set of keys.
* <p>
* @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
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/AbstractDoubleLinkedListMemoryCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/AbstractDoubleLinkedListMemoryCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/memory/AbstractDoubleLinkedListMemoryCache.java (working copy)
@@ -224,7 +224,7 @@
*
* @param key
* Identifies item to find
- * @return ICacheElement<K, V> if found, else null
+ * @return ICacheElement<K, V> if found, else null
* @throws IOException
*/
@Override
@@ -327,7 +327,7 @@
* This spools the last element in the LRU, if one exists.
* <p>
*
- * @return ICacheElement<K, V> if there was a last element, else null.
+ * @return ICacheElement<K, V> if there was a last element, else null.
* @throws Error
*/
private ICacheElement<K, V> spoolLastElement() throws Error
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/control/group/GroupId.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/control/group/GroupId.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/control/group/GroupId.java (working copy)
@@ -63,7 +63,7 @@
/**
* @param obj
- * @return cacheName.equals( g.cacheName ) && groupName.equals( g.groupName );
+ * @return cacheName.equals( g.cacheName ) &&groupName.equals( g.groupName );
*/
@Override
public boolean equals( Object obj )
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/control/CompositeCacheConfigurator.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/control/CompositeCacheConfigurator.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/control/CompositeCacheConfigurator.java (working copy)
@@ -48,8 +48,8 @@
* This class configures JCS based on a properties object.
* <p>
* This class is based on the log4j class org.apache.log4j.PropertyConfigurator which was made by:
- * "Luke Blanshard" <[email protected]>"Mark DONSZELMANN" <[email protected]>"Anders Kristensen"
- * <[email protected]>
+ * "Luke Blanshard" <[email protected]>"Mark DONSZELMANN" <[email protected]>"Anders Kristensen"
+ * <[email protected]>
*/
public class CompositeCacheConfigurator
{
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/control/CompositeCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/control/CompositeCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/control/CompositeCache.java (working copy)
@@ -218,7 +218,7 @@
* Put an item into the cache. If it is localOnly, then do no notify remote or lateral
* auxiliaries.
* <p>
- * @param cacheElement the ICacheElement<K, V>
+ * @param cacheElement the ICacheElement<K, V>
* @param localOnly Whether the operation should be restricted to local auxiliaries.
* @throws IOException
*/
@@ -627,7 +627,7 @@
* Gets multiple items from the cache based on the given set of keys.
* <p>
* @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
@@ -641,7 +641,7 @@
* laterally for this data.
* <p>
* @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( Set<K> keys )
@@ -816,7 +816,7 @@
* Build a map of all the matching elements in all of the auxiliaries and memory.
* <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 for any matching keys
*/
@Override
@@ -830,7 +830,7 @@
* go remote or laterally for this data.
* <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 for any matching keys
*/
public Map<K, ICacheElement<K, V>> localGetMatching( String pattern )
@@ -848,7 +848,7 @@
* <p>
* @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( String pattern, boolean localOnly )
@@ -878,10 +878,10 @@
/**
* Gets the key array from the memcache. Builds a set of matches. Calls getMultiple with the
- * set. Returns a map: key -> result.
+ * set. Returns a map: key -> result.
* <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 for any matching keys
* @throws IOException
*/
@@ -906,7 +906,7 @@
* <p>
* @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
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheServiceNonLocal.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheServiceNonLocal.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheServiceNonLocal.java (working copy)
@@ -85,7 +85,7 @@
* @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
*/
@@ -98,7 +98,7 @@
* @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
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheService.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheService.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheService.java (working copy)
@@ -49,7 +49,7 @@
* <p>
* @param cacheName
* @param key
- * @return the ICacheElement<K, V> or null if not found
+ * @return the ICacheElement<K, V> or null if not found
* @throws ObjectNotFoundException
* @throws IOException
*/
@@ -61,7 +61,7 @@
* <p>
* @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 ObjectNotFoundException
* @throws IOException
@@ -74,7 +74,7 @@
* <p>
* @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
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheEventQueue.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheEventQueue.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheEventQueue.java (working copy)
@@ -40,7 +40,7 @@
/**
* Initializes the queue.
- * <,p>
+ * <p>
* @param listener
* @param listenerId
* @param cacheName
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheElementSerialized.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheElementSerialized.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheElementSerialized.java (working copy)
@@ -24,7 +24,7 @@
* <p>
* The value is stored as a byte array. This should allow for a variety of serialization mechanisms.
* <p>
- * This currently extends ICacheElement<K, V> for backward compatibility.
+ * This currently extends ICacheElement<K, V> for backward compatibility.
*<p>
* @author Aaron Smuts
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheElement.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheElement.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICacheElement.java (working copy)
@@ -36,7 +36,7 @@
{
/**
- * Gets the cacheName attribute of the ICacheElement<K, V> object. The cacheName
+ * Gets the cacheName attribute of the ICacheElement<K, V> object. The cacheName
* is also known as the region name.
*
* @return The cacheName value
@@ -44,7 +44,7 @@
String getCacheName();
/**
- * Gets the key attribute of the ICacheElement<K, V> object
+ * Gets the key attribute of the ICacheElement<K, V> object
*
* @return The key value
*/
@@ -51,7 +51,7 @@
K getKey();
/**
- * Gets the val attribute of the ICacheElement<K, V> object
+ * Gets the val attribute of the ICacheElement<K, V> object
*
* @return The val value
*/
@@ -58,7 +58,7 @@
V getVal();
/**
- * Gets the attributes attribute of the ICacheElement<K, V> object
+ * Gets the attributes attribute of the ICacheElement<K, V> object
*
* @return The attributes value
*/
@@ -65,7 +65,7 @@
IElementAttributes getElementAttributes();
/**
- * Sets the attributes attribute of the ICacheElement<K, V> object
+ * Sets the attributes attribute of the ICacheElement<K, V> object
*
* @param attr
* The new attributes value
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/engine/behavior/ICache.java (working copy)
@@ -29,7 +29,7 @@
/**
* This is the top level interface for all cache like structures. It defines the methods used
* internally by JCS to access, modify, and instrument such structures.
- * <p>
+ *
* This allows for a suite of reusable components for accessing such structures, for example
* asynchronous access via an event queue.
*/
@@ -38,7 +38,7 @@
{
/**
* Puts an item to the cache.
- * <p>
+ *
* @param element
* @throws IOException
*/
@@ -47,7 +47,7 @@
/**
* Gets an item from the cache.
- * <p>
+ *
* @param key
* @return a cache element, or null if there is no data in cache for this key
* @throws IOException
@@ -57,9 +57,9 @@
/**
* Gets multiple items from the cache based on the given set of keys.
- * <p>
+ *
* @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)
@@ -67,13 +67,13 @@
/**
* Gets items from the cache matching the given pattern. Items from memory will replace those from remote sources.
- * <p>
+ *
* This only works with string keys. It's too expensive to do a toString on every key.
- * <p>
+ *
* Auxiliaries will do their best to handle simple expressions. For instance, the JDBC disk cache will convert * to % and . to _
- * <p>
+ *
* @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)
@@ -81,7 +81,7 @@
/**
* Removes an item from the cache.
- * <p>
+ *
* @param key
* @return false if there was an error in removal
* @throws IOException
@@ -91,7 +91,7 @@
/**
* Removes all cached items from the cache.
- * <p>
+ *
* @throws IOException
*/
void removeAll()
@@ -106,7 +106,7 @@
/**
* Returns the current cache size in number of elements.
- * <p>
+ *
* @return number of elements
*/
int getSize();
@@ -113,7 +113,7 @@
/**
* Returns the cache status.
- * <p>
+ *
* @return Alive or Error
*/
CacheStatus getStatus();
@@ -120,7 +120,7 @@
/**
* Returns the cache stats.
- * <p>
+ *
* @return String of important historical information.
*/
String getStats();
@@ -127,7 +127,7 @@
/**
* Returns the cache name.
- * <p>
+ *
* @return usually the region name.
*/
String getCacheName();
@@ -134,7 +134,7 @@
/**
* Sets the key matcher used by get matching.
- * <p>
+ *
* @param keyMatcher
*/
void setKeyMatcher( IKeyMatcher<K> keyMatcher );
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/value/RemoteCacheResponse.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/value/RemoteCacheResponse.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/value/RemoteCacheResponse.java (working copy)
@@ -38,7 +38,7 @@
private String errorMessage;
/**
- * The payload. Typically a key / ICacheElement<K, V> map. A normal get will return a map with one
+ * The payload. Typically a key / ICacheElement<K, V> map. A normal get will return a map with one
* record.
*/
private T payload;
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/server/RemoteCacheStartupServlet.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/server/RemoteCacheStartupServlet.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/server/RemoteCacheStartupServlet.java (working copy)
@@ -40,19 +40,19 @@
* in a tomcat base. This give you an easy way to monitor its activity.
* <p>
* <code>
- * <servlet>
- <servlet-name>JCSRemoteCacheStartupServlet</servlet-name>
- <servlet-class>
+ * servlet>
+ <servlet-name>JCSRemoteCacheStartupServlet</servlet-name>
+ <servlet-class>
org.apache.commons.jcs.auxiliary.remote.server.RemoteCacheStartupServlet
- </servlet-class>
- <load-on-startup>1</load-on-startup>
- </servlet>
+ </servlet-class>
+ <load-on-startup>1</load-on-startup>
+ </servlet>
- <servlet-mapping>
- <servlet-name>JCSRemoteCacheStartupServlet</servlet-name>
- <url-pattern>/jcs</url-pattern>
- </servlet-mapping>
+ <servlet-mapping>
+ <servlet-name>JCSRemoteCacheStartupServlet</servlet-name>
+ <url-pattern>/jcs</url-pattern>
+ </servlet-mapping>
* </code>
* @author Aaron Smuts
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/server/RemoteCacheServer.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/server/RemoteCacheServer.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/server/RemoteCacheServer.java (working copy)
@@ -204,8 +204,8 @@
/**
* Puts a cache bean to the remote cache and notifies all listeners which <br>
* <ol>
- * <li>have a different listener id than the originating host; <li>are currently subscribed to
- * the related cache.
+ * <li>have a different listener id than the originating host;</li>
+ * <li>are currently subscribed to the related cache.</li>
* </ol>
* <p>
* @param item
@@ -679,7 +679,7 @@
* <p>
* @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
*/
@@ -698,7 +698,7 @@
* @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
*/
@@ -724,7 +724,7 @@
* @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( String cacheName, Set<K> keys, long requesterId )
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/http/server/AbstractRemoteCacheService.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/http/server/AbstractRemoteCacheService.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/http/server/AbstractRemoteCacheService.java (working copy)
@@ -256,7 +256,7 @@
* <p>
* @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
*/
@@ -275,7 +275,7 @@
* @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
*/
@@ -301,7 +301,7 @@
* @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
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/http/client/RemoteHttpCacheClient.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/http/client/RemoteHttpCacheClient.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/http/client/RemoteHttpCacheClient.java (working copy)
@@ -143,7 +143,7 @@
* <p>
* @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
*/
@@ -160,7 +160,7 @@
* @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
*/
@@ -194,7 +194,7 @@
* <p>
* @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
*/
@@ -211,7 +211,7 @@
* @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
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteCacheNoWait.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteCacheNoWait.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/RemoteCacheNoWait.java (working copy)
@@ -233,7 +233,7 @@
* request on to the server rather than looping through the requested keys.
* <p>
* @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
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/AbstractRemoteCacheNoWaitFacade.java (working copy)
@@ -142,7 +142,7 @@
* Synchronously reads from the remote cache.
* <p>
* @param key
- * @return Either an ICacheElement<K, V> or null if it is not found.
+ * @return Either an ICacheElement<K, V> or null if it is not found.
*/
@Override
public ICacheElement<K, V> get( K key )
@@ -195,7 +195,7 @@
* Gets multiple items from the cache based on the given set of keys.
* <p>
* @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
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/AbstractRemoteCacheListener.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/AbstractRemoteCacheListener.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/AbstractRemoteCacheListener.java (working copy)
@@ -127,7 +127,8 @@
}
/**
- * Gets the remoteType attribute of the RemoteCacheListener object <p.
+ * Gets the remoteType attribute of the RemoteCacheListener object
+ * <p>
* @return The remoteType value
* @throws IOException
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/AbstractRemoteAuxiliaryCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/AbstractRemoteAuxiliaryCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/remote/AbstractRemoteAuxiliaryCache.java (working copy)
@@ -316,7 +316,7 @@
* Gets multiple items from the cache based on the given set of keys.
* <p>
* @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
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPService.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPService.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPService.java (working copy)
@@ -204,7 +204,7 @@
/**
* @param cacheName
* @param key
- * @return ICacheElement<K, V> if found.
+ * @return ICacheElement<K, V> if found.
* @throws IOException
*/
@Override
@@ -220,7 +220,7 @@
* @param cacheName
* @param key
* @param requesterId
- * @return ICacheElement<K, V> if found.
+ * @return ICacheElement<K, V> if found.
* @throws IOException
*/
@Override
@@ -254,7 +254,7 @@
* <p>
* @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
*/
@@ -271,7 +271,7 @@
* @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
*/
@@ -307,7 +307,7 @@
* <p>
* @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
*/
@@ -326,7 +326,7 @@
* @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
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPDiscoveryListener.java (working copy)
@@ -88,7 +88,7 @@
* 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 facade - facade (for region) => multiple lateral clients.
* @return true if the facade was not already registered.
*/
public synchronized boolean addNoWaitFacade( String cacheName, LateralCacheNoWaitFacade<?, ?> facade )
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/socket/tcp/LateralTCPCacheFactory.java (working copy)
@@ -226,7 +226,7 @@
* <p>
* @param lca configuration for the creation of a new service instance
*
- * @return ICacheServiceNonLocal<K, V>
+ * @return ICacheServiceNonLocal<K, V>
*/
// Need to cast because of common map for all cache services
@SuppressWarnings("unchecked")
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralElementDescriptor.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralElementDescriptor.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralElementDescriptor.java (working copy)
@@ -60,7 +60,7 @@
/**
* Constructor for the LateralElementDescriptor object
* <p>
- * @param ce ICacheElement<K, V> payload
+ * @param ce ICacheElement<K, V> payload
*/
public LateralElementDescriptor( ICacheElement<K, V> ce )
{
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralCacheNoWaitFacade.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralCacheNoWaitFacade.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralCacheNoWaitFacade.java (working copy)
@@ -241,7 +241,7 @@
* Gets multiple items from the cache based on the given set of keys.
* <p>
* @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
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralCacheNoWait.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralCacheNoWait.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralCacheNoWait.java (working copy)
@@ -124,7 +124,7 @@
* Synchronously reads from the lateral cache.
* <p>
* @param key
- * @return ICacheElement<K, V> if found, else null
+ * @return ICacheElement<K, V> if found, else null
*/
@Override
public ICacheElement<K, V> get( K key )
@@ -161,7 +161,7 @@
* Gets multiple items from the cache based on the given set of keys.
* <p>
* @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
@@ -189,7 +189,7 @@
* Synchronously reads from the lateral cache.
* <p>
* @param pattern
- * @return ICacheElement<K, V> if found, else empty
+ * @return ICacheElement<K, V> if found, else empty
*/
@Override
public Map<K, ICacheElement<K, V>> getMatching(String pattern)
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/lateral/LateralCache.java (working copy)
@@ -118,7 +118,7 @@
* The performance costs are too great. It is not recommended that you enable lateral gets.
* <p>
* @param key
- * @return ICacheElement<K, V> or null
+ * @return ICacheElement<K, V> or null
* @throws IOException
*/
@Override
@@ -145,7 +145,7 @@
/**
* @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 of these keys
* @throws IOException
*/
@@ -173,7 +173,7 @@
* Gets multiple items from the cache based on the given set of keys.
* <p>
* @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
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/mysql/MySQLDiskCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/mysql/MySQLDiskCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/mysql/MySQLDiskCache.java (working copy)
@@ -148,7 +148,7 @@
}
/**
- * Removed the expired. (now - create time) > max life seconds * 1000
+ * Removed the expired. (now - create time) > max life seconds * 1000
* <p>
* If we are currently optimizing, then this method will balk and do nothing.
* <p>
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/JDBCDiskCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/JDBCDiskCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/jdbc/JDBCDiskCache.java (working copy)
@@ -71,7 +71,7 @@
* );
* </pre>
* <p>
- * The cleanup thread will delete non eternal items where (now - create time) > max life seconds *
+ * The cleanup thread will delete non eternal items where (now - create time) > max life seconds *
* 1000
* <p>
* To speed up the deletion the SYSTEM_EXPIRE_TIME_SECONDS is used instead. It is recommended that
@@ -807,7 +807,7 @@
}
/**
- * Removed the expired. (now - create time) > max life seconds * 1000
+ * Removed the expired. (now - create time) > max life seconds * 1000
* <p>
* @return the number deleted
*/
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/indexed/IndexedDiskCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/indexed/IndexedDiskCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/indexed/IndexedDiskCache.java (working copy)
@@ -496,7 +496,7 @@
* <p>
*
* @param ce
- * The ICacheElement<K, V> to put to disk.
+ * The ICacheElement<K, V> to put to disk.
*/
@Override
protected void processUpdate(ICacheElement<K, V> ce)
@@ -611,7 +611,7 @@
* <p>
*
* @param key
- * @return ICacheElement<K, V> or null
+ * @return ICacheElement<K, V> or null
* @see AbstractDiskCache#doGet
*/
@Override
@@ -663,7 +663,7 @@
* <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
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/block/BlockDiskCache.java (working copy)
@@ -254,7 +254,7 @@
* Gets matching items from the cache.
* <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
@@ -300,7 +300,7 @@
}
/**
- * Gets the ICacheElement<K, V> for the key if it is in the cache. The program flow is as follows:
+ * Gets the ICacheElement<K, V> for the key if it is in the cache. The program flow is as follows:
* <ol>
* <li>Make sure the disk cache is alive.</li> <li>Get a read lock.</li> <li>See if the key is
* in the key store.</li> <li>If we found a key, ask the BlockDisk for the object at the
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/PurgatoryElement.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/PurgatoryElement.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/PurgatoryElement.java (working copy)
@@ -25,7 +25,7 @@
/**
* Implementation of cache elements in purgatory.
- * <p>
+ *
* Elements are stored in purgatory when they are spooled to the auxiliary cache, but have not yet
* been written to disk.
*/
@@ -42,8 +42,8 @@
private ICacheElement<K, V> cacheElement;
/**
- * Constructor for the PurgatoryElement<K, V> object
- * <p>
+ * Constructor for the PurgatoryElement<K, V> object
+ *
* @param cacheElement CacheElement
*/
public PurgatoryElement( ICacheElement<K, V> cacheElement )
@@ -56,7 +56,7 @@
/**
* Gets the spoolable property.
- * <p>
+ *
* @return The spoolable value
*/
public boolean isSpoolable()
@@ -66,7 +66,7 @@
/**
* Sets the spoolable property.
- * <p>
+ *
* @param spoolable The new spoolable value
*/
public void setSpoolable( boolean spoolable )
@@ -76,7 +76,7 @@
/**
* Get the wrapped cache element.
- * <p>
+ *
* @return ICacheElement
*/
public ICacheElement<K, V> getCacheElement()
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/AbstractDiskCache.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/AbstractDiskCache.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/disk/AbstractDiskCache.java (working copy)
@@ -47,11 +47,11 @@
/**
* Abstract class providing a base implementation of a disk cache, which can be easily extended to
* implement a disk cache for a specific persistence mechanism.
- * <p>
+ *
* When implementing the abstract methods note that while this base class handles most things, it
* does not acquire or release any locks. Implementations should do so as necessary. This is mainly
* done to minimize the time spent in critical sections.
- * <p>
+ *
* Error handling in this class needs to be addressed. Currently if an exception is thrown by the
* persistence mechanism, this class destroys the event queue. Should it also destroy purgatory?
* Should it dispose itself?
@@ -69,7 +69,7 @@
* Map where elements are stored between being added to this cache and actually spooled to disk.
* This allows puts to the disk cache to return quickly, and the more expensive operation of
* serializing the elements to persistent storage queued for later.
- * <p>
+ *
* If the elements are pulled into the memory cache while the are still in purgatory, writing to
* disk can be canceled.
*/
@@ -104,7 +104,7 @@
/**
* Construct the abstract disk cache, create event queues and purgatory. Child classes should
* set the alive flag to true after they are initialized.
- * <p>
+ *
* @param attr
*/
protected AbstractDiskCache( IDiskCacheAttributes attr )
@@ -141,7 +141,7 @@
/**
* Purgatory size of -1 means to use a HashMap with no size limit. Anything greater will use an
* LRU map of some sort.
- * <p>
+ *
* TODO Currently setting this to 0 will cause nothing to be put to disk, since it will assume
* that if an item is not in purgatory, then it must have been plucked. We should make 0
* work, a way to not use purgatory.
@@ -177,10 +177,10 @@
/**
* Adds the provided element to the cache. Element will be added to purgatory, and then queued
* for later writing to the serialized storage mechanism.
- * <p>
+ *
* An update results in a put event being created. The put event will call the handlePut method
* defined here. The handlePut method calls the implemented doPut on the child.
- * <p>
+ *
* @param cacheElement
* @throws IOException
* @see org.apache.commons.jcs.engine.behavior.ICache#update
@@ -224,9 +224,9 @@
/**
* Check to see if the item is in purgatory. If so, return it. If not, check to see if we have
* it on disk.
- * <p>
+ *
* @param key
- * @return ICacheElement<K, V> or null
+ * @return ICacheElement<K, V> or null
* @see AuxiliaryCache#get
*/
@Override
@@ -302,14 +302,14 @@
/**
* Gets items from the cache matching the given pattern. Items from memory will replace those
* from remote sources.
- * <p>
+ *
* This only works with string keys. It's too expensive to do a toString on every key.
- * <p>
+ *
* Auxiliaries will do their best to handle simple expressions. For instance, the JDBC disk
* cache will convert * to % and . to _
- * <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 matching the pattern.
* @throws IOException
*/
@@ -341,9 +341,9 @@
/**
* Gets multiple items from the cache based on the given set of keys.
- * <p>
+ *
* @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
@@ -369,7 +369,7 @@
/**
* The keys in the cache.
- * <p>
+ *
* @see org.apache.commons.jcs.auxiliary.AuxiliaryCache#getKeySet()
*/
@Override
@@ -377,7 +377,7 @@
/**
* Removes are not queued. A call to remove is immediate.
- * <p>
+ *
* @param key
* @return whether the item was present to be removed.
* @throws IOException
@@ -449,14 +449,14 @@
/**
* Adds a dispose request to the disk cache.
- * <p>
+ *
* Disposal proceeds in several steps.
* <ol>
* <li>Prior to this call the Composite cache dumped the memory into the disk cache. If it is
- * large then we need to wait for the event queue to finish.
+ * large then we need to wait for the event queue to finish.</li>
* <li>Wait until the event queue is empty of until the configured ShutdownSpoolTimeLimit is
- * reached.
- * <li>Call doDispose on the concrete impl.
+ * reached.</li>
+ * <li>Call doDispose on the concrete impl.</li>
* </ol>
* @throws IOException
*/
@@ -524,7 +524,7 @@
/**
* Gets basic stats for the abstract disk cache.
- * <p>
+ *
* @return String
*/
@Override
@@ -535,7 +535,7 @@
/**
* Returns semi-structured data.
- * <p>
+ *
* @see org.apache.commons.jcs.auxiliary.AuxiliaryCache#getStatistics()
*/
@Override
@@ -571,7 +571,7 @@
/**
* Size cannot be determined without knowledge of the cache implementation, so subclasses will
* need to implement this method.
- * <p>
+ *
* @return the number of items.
* @see ICache#getSize
*/
@@ -761,17 +761,17 @@
* Before the event logging layer, the subclasses implemented the do* methods. Now the do*
* methods call the *WithEventLogging method on the super. The *WithEventLogging methods call
* the abstract process* methods. The children implement the process methods.
- * <p>
+ *
* ex. doGet calls getWithEventLogging, which calls processGet
*/
/**
* Get a value from the persistent store.
- * <p>
+ *
* 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
* abstract process* methods. The children implement the process methods.
- * <p>
+ *
* @param key Key to locate value for.
* @return An object matching key, or null.
* @throws IOException
@@ -784,11 +784,11 @@
/**
* Get a value from the persistent store.
- * <p>
+ *
* 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
* abstract process* methods. The children implement the process methods.
- * <p>
+ *
* @param pattern Used to match keys.
* @return A map of matches..
* @throws IOException
@@ -801,11 +801,11 @@
/**
* Add a cache element to the persistent store.
- * <p>
+ *
* 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
* abstract process* methods. The children implement the process methods.
- * <p>
+ *
* @param cacheElement
* @throws IOException
*/
@@ -817,11 +817,11 @@
/**
* Remove an object from the persistent store if found.
- * <p>
+ *
* 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
* abstract process* methods. The children implement the process methods.
- * <p>
+ *
* @param key Key of object to remove.
* @return whether or no the item was present when removed
* @throws IOException
@@ -834,11 +834,11 @@
/**
* Remove all objects from the persistent store.
- * <p>
+ *
* 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
* abstract process* methods. The children implement the process methods.
- * <p>
+ *
* @throws IOException
*/
protected final void doRemoveAll()
@@ -850,11 +850,11 @@
/**
* Dispose of the persistent store. Note that disposal of purgatory and setting alive to false
* does NOT need to be done by this method.
- * <p>
+ *
* 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
* abstract process* methods. The children implement the process methods.
- * <p>
+ *
* @throws IOException
*/
protected final void doDispose()
@@ -865,7 +865,7 @@
/**
* Gets the extra info for the event log.
- * <p>
+ *
* @return disk location
*/
@Override
@@ -876,7 +876,7 @@
/**
* This is used by the event logging.
- * <p>
+ *
* @return the location of the disk, either path or ip.
*/
protected abstract String getDiskLocation();
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/AuxiliaryCacheFactory.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/AuxiliaryCacheFactory.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/AuxiliaryCacheFactory.java (working copy)
@@ -30,7 +30,7 @@
{
/**
* Creates an auxiliary using the supplied attributes. Adds it to the composite cache manager.
- * <p>
+ *
* @param attr
* @param cacheMgr This allows auxiliaries to reference the manager without assuming that it is
* a singleton. This will allow JCS to be a non-singleton. Also, it makes it easier to
@@ -57,7 +57,7 @@
/**
* Sets the name attribute of the AuxiliaryCacheFactory object
- * <p>
+ *
* @param s The new name value
*/
void setName( String s );
@@ -64,7 +64,7 @@
/**
* Gets the name attribute of the AuxiliaryCacheFactory object
- * <p>
+ *
* @return The name value
*/
String getName();
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/AbstractAuxiliaryCacheEventLogging.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/AbstractAuxiliaryCacheEventLogging.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/auxiliary/AbstractAuxiliaryCacheEventLogging.java (working copy)
@@ -31,7 +31,7 @@
/**
* All ICacheEvents are defined as final. Children must implement process events. These are wrapped
* in event log parent calls.
- * <p>
+ *
* You can override the public method, but if you don't, the default will call getWithTiming.
*/
public abstract class AbstractAuxiliaryCacheEventLogging<K, V>
@@ -39,7 +39,7 @@
{
/**
* Puts an item into the cache.
- * <p>
+ *
* @param cacheElement
* @throws IOException
*/
@@ -52,7 +52,7 @@
/**
* Puts an item into the cache. Wrapped in logging.
- * <p>
+ *
* @param cacheElement
* @throws IOException
*/
@@ -72,7 +72,7 @@
/**
* Implementation of put.
- * <p>
+ *
* @param cacheElement
* @throws IOException
*/
@@ -81,7 +81,7 @@
/**
* Gets the item from the cache.
- * <p>
+ *
* @param key
* @return ICacheElement, a wrapper around the key, value, and attributes
* @throws IOException
@@ -95,7 +95,7 @@
/**
* Gets the item from the cache. Wrapped in logging.
- * <p>
+ *
* @param key
* @return ICacheElement, a wrapper around the key, value, and attributes
* @throws IOException
@@ -116,7 +116,7 @@
/**
* Implementation of get.
- * <p>
+ *
* @param key
* @return ICacheElement, a wrapper around the key, value, and attributes
* @throws IOException
@@ -126,9 +126,9 @@
/**
* Gets multiple items from the cache based on the given set of keys.
- * <p>
+ *
* @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
*/
@@ -141,9 +141,9 @@
/**
* Gets multiple items from the cache based on the given set of keys.
- * <p>
+ *
* @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
*/
@@ -164,9 +164,9 @@
/**
* Implementation of getMultiple.
- * <p>
+ *
* @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
*/
@@ -176,14 +176,14 @@
/**
* Gets items from the cache matching the given pattern. Items from memory will replace those
* from remote sources.
- * <p>
+ *
* This only works with string keys. It's too expensive to do a toString on every key.
- * <p>
+ *
* Auxiliaries will do their best to handle simple expressions. For instance, the JDBC disk
* cache will convert * to % and . to _
- * <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 matching the pattern.
* @throws IOException
*/
@@ -196,9 +196,9 @@
/**
* Gets mmatching items from the cache based on the given pattern.
- * <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 matching the pattern.
* @throws IOException
*/
@@ -218,9 +218,9 @@
/**
* Implementation of getMatching.
- * <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 matching the pattern.
* @throws IOException
*/
@@ -229,7 +229,7 @@
/**
* Removes the item from the cache. Wraps the remove in event logs.
- * <p>
+ *
* @param key
* @return boolean, whether or not the item was removed
* @throws IOException
@@ -243,7 +243,7 @@
/**
* Removes the item from the cache. Wraps the remove in event logs.
- * <p>
+ *
* @param key
* @return boolean, whether or not the item was removed
* @throws IOException
@@ -264,7 +264,7 @@
/**
* Specific implementation of remove.
- * <p>
+ *
* @param key
* @return boolean, whether or not the item was removed
* @throws IOException
@@ -274,7 +274,7 @@
/**
* Removes all from the region. Wraps the removeAll in event logs.
- * <p>
+ *
* @throws IOException
*/
@Override
@@ -286,7 +286,7 @@
/**
* Removes all from the region. Wraps the removeAll in event logs.
- * <p>
+ *
* @throws IOException
*/
protected final void removeAllWithEventLogging()
@@ -305,7 +305,7 @@
/**
* Specific implementation of removeAll.
- * <p>
+ *
* @throws IOException
*/
protected abstract void processRemoveAll()
@@ -313,7 +313,7 @@
/**
* Synchronously dispose the remote cache; if failed, replace the remote handle with a zombie.
- * <p>
+ *
* @throws IOException
*/
@Override
@@ -326,7 +326,7 @@
/**
* Synchronously dispose the remote cache; if failed, replace the remote handle with a zombie.
* Wraps the removeAll in event logs.
- * <p>
+ *
* @throws IOException
*/
protected final void disposeWithEventLogging()
@@ -345,7 +345,7 @@
/**
* Specific implementation of dispose.
- * <p>
+ *
* @throws IOException
*/
protected abstract void processDispose()
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/admin/servlet/JCSAdminServlet.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/admin/servlet/JCSAdminServlet.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/admin/servlet/JCSAdminServlet.java (working copy)
@@ -95,7 +95,6 @@
* @param response
* @param context
* @return Template
- * @throws Exception
*
*/
@Override
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/admin/JCSJMXBean.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/admin/JCSJMXBean.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/admin/JCSJMXBean.java (working copy)
@@ -50,7 +50,7 @@
/**
* Tries to estimate how much data is in a region. This is expensive. If there are any non serializable objects in
* the region or an error occurs, suppresses exceptions and returns 0.
- * <p/>
+ * <p>
*
* @return int The size of the region in bytes.
*/
@@ -58,7 +58,7 @@
/**
* Clears all regions in the cache.
- * <p/>
+ * <p>
* If this class is running within a remote cache server, clears all regions via the <code>RemoteCacheServer</code>
* API, so that removes will be broadcast to client machines. Otherwise clears all regions in the cache directly via
* the usual cache API.
@@ -67,7 +67,7 @@
/**
* Clears a particular cache region.
- * <p/>
+ * <p>
* If this class is running within a remote cache server, clears the region via the <code>RemoteCacheServer</code>
* API, so that removes will be broadcast to client machines. Otherwise clears the region directly via the usual
* cache API.
@@ -76,7 +76,7 @@
/**
* Removes a particular item from a particular region.
- * <p/>
+ * <p>
* If this class is running within a remote cache server, removes the item via the <code>RemoteCacheServer</code>
* API, so that removes will be broadcast to client machines. Otherwise clears the region directly via the usual
* cache API.
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/admin/JCSAdminBean.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/admin/JCSAdminBean.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/admin/JCSAdminBean.java (working copy)
@@ -177,7 +177,7 @@
/**
* Tries to estimate how much data is in a region. This is expensive. If there are any non serializable objects in
* the region or an error occurs, suppresses exceptions and returns 0.
- * <p/>
+ * <p>
*
* @return int The size of the region in bytes.
*/
@@ -190,7 +190,7 @@
/**
* Tries to estimate how much data is in a region. This is expensive. If there are any non serializable objects in
* the region or an error occurs, suppresses exceptions and returns 0.
- * <p/>
+ * <p>
*
* @return int The size of the region in bytes.
*/
@@ -279,7 +279,7 @@
/**
* Clears all regions in the cache.
- * <p/>
+ * <p>
* If this class is running within a remote cache server, clears all regions via the <code>RemoteCacheServer</code>
* API, so that removes will be broadcast to client machines. Otherwise clears all regions in the cache directly via
* the usual cache API.
@@ -324,7 +324,7 @@
/**
* Clears a particular cache region.
- * <p/>
+ * <p>
* If this class is running within a remote cache server, clears the region via the <code>RemoteCacheServer</code>
* API, so that removes will be broadcast to client machines. Otherwise clears the region directly via the usual
* cache API.
@@ -361,7 +361,7 @@
/**
* Removes a particular item from a particular region.
- * <p/>
+ * <p>
* If this class is running within a remote cache server, removes the item via the <code>RemoteCacheServer</code>
* API, so that removes will be broadcast to client machines. Otherwise clears the region directly via the usual
* cache API.
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/access/behavior/ICacheAccess.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/access/behavior/ICacheAccess.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/access/behavior/ICacheAccess.java (working copy)
@@ -80,7 +80,7 @@
throws CacheException;
/**
- * This method returns the ICacheElement<K, V> wrapper which provides access to element info and other
+ * This method returns the ICacheElement<K, V> wrapper which provides access to element info and other
* attributes.
* <p>
* This returns a reference to the wrapper. Any modifications will be reflected in the cache. No
@@ -92,7 +92,7 @@
* The last access time in the ElementAttributes should be current.
* <p>
* @param name Key the object is stored as
- * @return The ICacheElement<K, V> if the object is found or null
+ * @return The ICacheElement<K, V> if the object is found or null
*/
ICacheElement<K, V> getCacheElement( K name );
@@ -99,7 +99,7 @@
/**
* Get 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
+ * This method returns the ICacheElement<K, V> wrapper which provides access to element info and other
* attributes.
* <p>
* This returns a reference to the wrapper. Any modifications will be reflected in the cache. No
@@ -111,7 +111,7 @@
* The last access time in the ElementAttributes should be current.
* <p>
* @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 );
@@ -119,7 +119,7 @@
/**
* Get 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
+ * This method returns the ICacheElement<K, V> wrapper which provides access to element info and other
* attributes.
* <p>
* This returns a reference to the wrapper. Any modifications will be reflected in the cache. No
@@ -131,7 +131,7 @@
* The last access time in the ElementAttributes should be current.
* <p>
* @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 );
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/access/PartitionedCacheAccess.java (working copy)
@@ -206,7 +206,7 @@
}
/**
- * Gets the ICacheElement<K, V> (the wrapped object) for the key from the desired partition.
+ * Gets the ICacheElement<K, V> (the wrapped object) for the key from the desired partition.
* <p>
* @param key key
* @return result, null if not found.
Index: commons-jcs-core/src/main/java/org/apache/commons/jcs/access/CacheAccess.java
===================================================================
--- commons-jcs-core/src/main/java/org/apache/commons/jcs/access/CacheAccess.java (revision 1726611)
+++ commons-jcs-core/src/main/java/org/apache/commons/jcs/access/CacheAccess.java (working copy)
@@ -105,7 +105,7 @@
}
/**
- * This method returns the ICacheElement<K, V> wrapper which provides access to element info and other
+ * This method returns the ICacheElement<K, V> wrapper which provides access to element info and other
* attributes.
* <p>
* This returns a reference to the wrapper. Any modifications will be reflected in the cache. No
@@ -117,7 +117,7 @@
* The last access time in the ElementAttributes should be current.
* <p>
* @param name Key the Serializable is stored as
- * @return The ICacheElement<K, V> if the object is found or null
+ * @return The ICacheElement<K, V> if the object is found or null
*/
@Override
public ICacheElement<K, V> getCacheElement( K name )
@@ -128,7 +128,7 @@
/**
* Get 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
+ * This method returns the ICacheElement<K, V> wrapper which provides access to element info and other
* attributes.
* <p>
* This returns a reference to the wrapper. Any modifications will be reflected in the cache. No
@@ -140,7 +140,7 @@
* The last access time in the ElementAttributes should be current.
* <p>
* @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( Set<K> names )
@@ -151,7 +151,7 @@
/**
* Get 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
+ * This method returns the ICacheElement<K, V> wrapper which provides access to element info and other
* attributes.
* <p>
* This returns a reference to the wrapper. Any modifications will be reflected in the cache. No
@@ -163,7 +163,7 @@
* The last access time in the ElementAttributes should be current.
* <p>
* @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( String pattern )
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
