You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jcs-dev@jakarta.apache.org by as...@apache.org on 2005/11/10 03:15:24 UTC
svn commit: r332199 - in /jakarta/jcs/trunk/src/java/org/apache/jcs:
auxiliary/lateral/behavior/ auxiliary/remote/ auxiliary/remote/behavior/
auxiliary/remote/server/ engine/ engine/control/
engine/control/event/behavior/ engine/control/group/ engine/m...
Author: asmuts
Date: Wed Nov 9 18:15:03 2005
New Revision: 332199
URL: http://svn.apache.org/viewcvs?rev=332199&view=rev
Log:
cleaned javadocs
Modified:
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/lateral/behavior/ILateralCacheService.java
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteCacheNoWait.java
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteCacheRestore.java
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteUtils.java
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/ZombieRemoteCacheService.java
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/behavior/IRemoteCacheListener.java
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/server/RemoteCacheServerAttributes.java
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/server/RemoteCacheServerListener.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/Attributes.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheAdaptor.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheUtils.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheWatchRepairable.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CompositeCacheAttributes.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ElementAttributes.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ZombieCacheService.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ZombieCacheWatch.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/CompositeCacheConfigurator.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/CompositeCacheManager.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/event/behavior/IElementEventQueue.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/group/GroupAttrName.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/group/GroupId.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/AbstractMemoryCache.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/lru/LRUMemoryCache.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/util/DoubleLinkedList.java
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/lateral/behavior/ILateralCacheService.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/lateral/behavior/ILateralCacheService.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/lateral/behavior/ILateralCacheService.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/lateral/behavior/ILateralCacheService.java Wed Nov 9 18:15:03 2005
@@ -31,17 +31,36 @@
extends ICacheService
{
- /** Puts a cache item to the cache. */
+ /** Puts a cache item to the cache.
+ * @param item
+ * @param requesterId
+ * @throws IOException
+ */
public void update( ICacheElement item, long requesterId )
throws IOException;
- /** Removes the given key from the specified cache. */
+ /** Removes the given key from the specified cache.
+ * @param cacheName
+ * @param key
+ * @param requesterId
+ * @throws IOException
+ */
public void remove( String cacheName, Serializable key, long requesterId )
throws IOException;
- /** Remove all keys from the sepcified cache. */
+ /** Remove all keys from the sepcified cache.
+ * @param cacheName
+ * @param requesterId
+ * @throws IOException
+ */
public void removeAll( String cacheName, long requesterId )
throws IOException;
+ /**
+ *
+ * @param cacheName
+ * @param groupName
+ * @return
+ */
public Set getGroupKeys( String cacheName, String groupName );
}
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteCacheNoWait.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteCacheNoWait.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteCacheNoWait.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteCacheNoWait.java Wed Nov 9 18:15:03 2005
@@ -73,7 +73,10 @@
}
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICache#update(org.apache.jcs.engine.behavior.ICacheElement)
+ */
public void update( ICacheElement ce )
throws IOException
{
@@ -89,7 +92,12 @@
}
}
- /** Synchronously reads from the remote cache. */
+ /**
+ * Synchronously reads from the remote cache.
+ * @param key
+ * @return
+ * @throws IOException
+ */
public ICacheElement get( Serializable key )
throws IOException
{
@@ -124,7 +132,11 @@
return cache.getGroupKeys( groupName );
}
- /** Adds a remove request to the remote cache. */
+ /** Adds a remove request to the remote cache.
+ * @param key
+ * @return
+ * @throws IOException
+ */
public boolean remove( Serializable key )
throws IOException
{
@@ -141,7 +153,10 @@
return false;
}
- /** Adds a removeAll request to the remote cache. */
+ /**
+ * Adds a removeAll request to the remote cache.
+ * @throws IOException
+ */
public void removeAll()
throws IOException
{
@@ -217,6 +232,7 @@
/**
* Replaces the remote cache service handle with the given handle and reset
* the event queue by starting up a new instance.
+ * @param remote
*/
public void fixCache( IRemoteCacheService remote )
{
@@ -251,7 +267,10 @@
return cache;
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see java.lang.Object#toString()
+ */
public String toString()
{
return "RemoteCacheNoWait: " + cache.toString();
@@ -279,7 +298,7 @@
ArrayList elems = new ArrayList();
- IStatElement se = null;
+ //IStatElement se = null;
// no data gathered here
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteCacheRestore.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteCacheRestore.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteCacheRestore.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteCacheRestore.java Wed Nov 9 18:15:03 2005
@@ -62,6 +62,7 @@
/**
* Returns true if the connection to the remote host for the corresponding
* cache manager can be successfully re-established.
+ * @return
*/
public boolean canFix()
{
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteUtils.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteUtils.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteUtils.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/RemoteUtils.java Wed Nov 9 18:15:03 2005
@@ -46,6 +46,9 @@
/**
* Creates and exports a registry on the specified port of the local host.
+ * @param port
+ * @return
+ * @throws RemoteException
*/
public static int createRegistry( int port )
throws RemoteException
@@ -61,7 +64,11 @@
return port;
}
- /** Description of the Method */
+ /**
+ * Loads properties for the named props file.
+ * @param propFile
+ * @return
+ * @throws IOException*/
public static Properties loadProps( String propFile )
throws IOException
{
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/ZombieRemoteCacheService.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/ZombieRemoteCacheService.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/ZombieRemoteCacheService.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/ZombieRemoteCacheService.java Wed Nov 9 18:15:03 2005
@@ -27,7 +27,7 @@
import org.apache.jcs.engine.behavior.ICacheElement;
/**
- * Description of the Class
+ * Zombie adapter for the remote cache service. It just balks.
*
*/
public class ZombieRemoteCacheService
@@ -35,17 +35,26 @@
implements IRemoteCacheService
{
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.auxiliary.remote.behavior.IRemoteCacheService#update(org.apache.jcs.engine.behavior.ICacheElement, long)
+ */
public void update( ICacheElement item, long listenerId )
{
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.auxiliary.remote.behavior.IRemoteCacheService#remove(java.lang.String, java.io.Serializable, long)
+ */
public void remove( String cacheName, Serializable key, long listenerId )
{
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.auxiliary.remote.behavior.IRemoteCacheService#removeAll(java.lang.String, long)
+ */
public void removeAll( String cacheName, long listenerId )
{
}
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/behavior/IRemoteCacheListener.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/behavior/IRemoteCacheListener.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/behavior/IRemoteCacheListener.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/behavior/IRemoteCacheListener.java Wed Nov 9 18:15:03 2005
@@ -40,6 +40,7 @@
* Get the id to be used by this manager.
*
* @return long
+ * @throws IOException
*/
public long getListenerId()
throws IOException;
@@ -50,6 +51,7 @@
* remote cache listener.
*
* @param id
+ * @throws IOException
*/
public void setListenerId( long id )
throws IOException;
@@ -58,6 +60,7 @@
* Gets the remoteType attribute of the IRemoteCacheListener object
*
* @return The remoteType value
+ * @throws IOException
*/
public int getRemoteType()
throws IOException;
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/server/RemoteCacheServerAttributes.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/server/RemoteCacheServerAttributes.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/server/RemoteCacheServerAttributes.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/server/RemoteCacheServerAttributes.java Wed Nov 9 18:15:03 2005
@@ -45,7 +45,7 @@
*/
private String clusterServers = "";
- private boolean getFromCluster = true;
+ //private boolean getFromCluster = true;
private int servicePort = 0;
@@ -123,7 +123,10 @@
this.remoteType = p;
}
- /** Description of the Method */
+ /**
+ * clones
+ * @return AuxiliaryCacheAttributes clone
+ */
public AuxiliaryCacheAttributes copy()
{
try
@@ -348,7 +351,10 @@
configFileName = s;
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see java.lang.Object#toString()
+ */
public String toString()
{
StringBuffer buf = new StringBuffer();
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/server/RemoteCacheServerListener.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/server/RemoteCacheServerListener.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/server/RemoteCacheServerListener.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/server/RemoteCacheServerListener.java Wed Nov 9 18:15:03 2005
@@ -102,6 +102,7 @@
*
* @param id
* The new listenerId value
+ * @throws IOException
*/
public void setListenerId( long id )
throws IOException
@@ -117,6 +118,7 @@
* Gets the listenerId attribute of the RemoteCacheServerListener object
*
* @return The listenerId value
+ * @throws IOException
*/
public long getListenerId()
throws IOException
@@ -137,6 +139,7 @@
* Gets the remoteType attribute of the RemoteCacheServerListener object
*
* @return The remoteType value
+ * @throws IOException
*/
public int getRemoteType()
throws IOException
@@ -150,6 +153,7 @@
/**
* Gets the instance attribute of the RemoteCacheServerListener class
+ * @param irca
*
* @return The instance value
*/
@@ -177,6 +181,8 @@
* incomplete for faster transmission. We don't want to pass data only
* invalidation. The next time it is used the local cache will get the new
* version from the remote store
+ * @param cb
+ * @throws IOException
*/
public void handlePut( ICacheElement cb )
throws IOException
@@ -194,7 +200,13 @@
cache.localUpdate( cb );
}
- /** Description of the Method */
+ /**
+ * Calls remove for the key on the named cache
+ *
+ * @param cacheName
+ * @param key
+ * @throws IOException
+ */
public void handleRemove( String cacheName, Serializable key )
throws IOException
{
@@ -219,7 +231,12 @@
cache.localRemove( key );
}
- /** Description of the Method */
+ /**
+ * Calls removeAl on the named cache region.
+ *
+ * @param cacheName
+ * @throws IOException
+ */
public void handleRemoveAll( String cacheName )
throws IOException
{
@@ -232,7 +249,12 @@
cache.removeAll();
}
- /** Description of the Method */
+ /**
+ * Calls freeCache on the named region.
+ *
+ * @param cacheName
+ * @throws IOException
+ */
public void handleDispose( String cacheName )
throws IOException
{
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/Attributes.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/Attributes.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/Attributes.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/Attributes.java Wed Nov 9 18:15:03 2005
@@ -105,7 +105,7 @@
*
* @param attr
*/
- private Attributes( Attributes attr )
+ protected Attributes( Attributes attr )
{
IS_NOFLUSH = attr.IS_NOFLUSH;
@@ -134,7 +134,10 @@
}
//public Object clone () {
- /** Description of the Method */
+ /**
+ * clone
+ * @return Attributes
+ */
public Attributes copy()
{
try
@@ -149,7 +152,11 @@
}
}
- /** Description of the Method */
+ /**
+ * Deep clone
+ *
+ * @return
+ */
public Object clone2()
{
@@ -309,7 +316,9 @@
// return 5;
// }
- /** Description of the Method */
+ /*
+ *
+ */
public String toString()
{
StringBuffer dump = new StringBuffer();
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheAdaptor.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheAdaptor.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheAdaptor.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheAdaptor.java Wed Nov 9 18:15:03 2005
@@ -45,6 +45,7 @@
*
* @param id
* The new listenerId value
+ * @throws IOException
*/
public void setListenerId( long id )
throws IOException
@@ -57,6 +58,7 @@
* Gets the listenerId attribute of the CacheAdaptor object
*
* @return The listenerId value
+ * @throws IOException
*/
public long getListenerId()
throws IOException
@@ -74,7 +76,12 @@
this.cache = cache;
}
- /** Description of the Method */
+ /**
+ * Puts an item into the cache.
+ *
+ * @param item
+ * @throws IOException
+ */
public void handlePut( ICacheElement item )
throws IOException
{
@@ -91,21 +98,30 @@
}
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICacheListener#handleRemove(java.lang.String, java.io.Serializable)
+ */
public void handleRemove( String cacheName, Serializable key )
throws IOException
{
cache.remove( key );
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICacheListener#handleRemoveAll(java.lang.String)
+ */
public void handleRemoveAll( String cacheName )
throws IOException
{
cache.removeAll();
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICacheListener#handleDispose(java.lang.String)
+ */
public void handleDispose( String cacheName )
throws IOException
{
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheUtils.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheUtils.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheUtils.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheUtils.java Wed Nov 9 18:15:03 2005
@@ -24,7 +24,9 @@
import java.io.Serializable;
/**
- * Description of the Class
+ * basic utility functions
+ *
+ * TODO move to util
*
*/
public class CacheUtils
@@ -35,7 +37,11 @@
{
}
- /** Returns a deeply cloned object. */
+ /** Returns a deeply cloned object.
+ * @param obj
+ * @return
+ * @throws IOException
+ */
public static Serializable dup( Serializable obj )
throws IOException
{
@@ -44,6 +50,9 @@
/**
* Returns the serialized form of the given object in a byte array.
+ * @param obj
+ * @return
+ * @throws IOException
*/
public static byte[] serialize( Serializable obj )
throws IOException
@@ -61,7 +70,11 @@
return baos.toByteArray();
}
- /** Returns the object deserialized from the given byte array. */
+ /** Returns the object deserialized from the given byte array.
+ * @param buf
+ * @return
+ * @throws IOException
+ */
public static Serializable deserialize( byte[] buf )
throws IOException
{
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheWatchRepairable.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheWatchRepairable.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheWatchRepairable.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheWatchRepairable.java Wed Nov 9 18:15:03 2005
@@ -87,6 +87,7 @@
* The feature to be added to the CacheListener attribute
* @param obj
* The feature to be added to the CacheListener attribute
+ * @throws IOException
*/
public void addCacheListener( String cacheName, ICacheListener obj )
throws IOException
@@ -113,6 +114,7 @@
*
* @param obj
* The feature to be added to the CacheListener attribute
+ * @throws IOException
*/
public void addCacheListener( ICacheListener obj )
throws IOException
@@ -131,7 +133,11 @@
cacheWatch.addCacheListener( obj );
}
- /** Description of the Method */
+ /**
+ * @param cacheName
+ * @param obj
+ * @throws IOException
+ */
public void removeCacheListener( String cacheName, ICacheListener obj )
throws IOException
{
@@ -149,7 +155,10 @@
cacheWatch.removeCacheListener( cacheName, obj );
}
- /** Description of the Method */
+ /**
+ * @param obj
+ * @throws IOException
+ */
public void removeCacheListener( ICacheListener obj )
throws IOException
{
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CompositeCacheAttributes.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CompositeCacheAttributes.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CompositeCacheAttributes.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CompositeCacheAttributes.java Wed Nov 9 18:15:03 2005
@@ -264,7 +264,7 @@
* If the value is -1, then there is no limit to the number of items to be
* spooled.
*
- * @param seconds
+ * @param maxSpoolPerRun
* The new maxSpoolPerRun value
*/
public void setMaxSpoolPerRun( int maxSpoolPerRun )
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ElementAttributes.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ElementAttributes.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ElementAttributes.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ElementAttributes.java Wed Nov 9 18:15:03 2005
@@ -107,7 +107,7 @@
*
* @param attr
*/
- private ElementAttributes( ElementAttributes attr )
+ protected ElementAttributes( ElementAttributes attr )
{
IS_ETERNAL = attr.IS_ETERNAL;
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ZombieCacheService.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ZombieCacheService.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ZombieCacheService.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ZombieCacheService.java Wed Nov 9 18:15:03 2005
@@ -24,51 +24,78 @@
import org.apache.jcs.engine.behavior.IZombie;
/**
- * Description of the Class
+ * Zombie adapter for any cache service. balks at every call.
*
*/
public class ZombieCacheService
implements ICacheService, IZombie
{
- /** Description of the Method */
+ /*
+ *
+ */
public void put( ICacheElement item )
{
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICacheService#update(org.apache.jcs.engine.behavior.ICacheElement)
+ */
public void update( ICacheElement item )
{
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICacheService#get(java.lang.String, java.io.Serializable)
+ */
public ICacheElement get( String cacheName, Serializable key )
{
return null;
}
- /** Description of the Method */
+
+ /**
+ *
+ * @param cacheName
+ * @param key
+ * @param container
+ * @return
+ */
public Serializable get( String cacheName, Serializable key, boolean container )
{
return null;
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICacheService#remove(java.lang.String, java.io.Serializable)
+ */
public void remove( String cacheName, Serializable key )
{
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICacheService#removeAll(java.lang.String)
+ */
public void removeAll( String cacheName )
{
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICacheService#dispose(java.lang.String)
+ */
public void dispose( String cacheName )
{
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICacheService#release()
+ */
public void release()
{
}
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ZombieCacheWatch.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ZombieCacheWatch.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ZombieCacheWatch.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/ZombieCacheWatch.java Wed Nov 9 18:15:03 2005
@@ -52,12 +52,18 @@
{
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICacheObserver#removeCacheListener(java.lang.String, org.apache.jcs.engine.behavior.ICacheListener)
+ */
public void removeCacheListener( String cacheName, ICacheListener obj )
{
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see org.apache.jcs.engine.behavior.ICacheObserver#removeCacheListener(org.apache.jcs.engine.behavior.ICacheListener)
+ */
public void removeCacheListener( ICacheListener obj )
{
}
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/CompositeCacheConfigurator.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/CompositeCacheConfigurator.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/CompositeCacheConfigurator.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/CompositeCacheConfigurator.java Wed Nov 9 18:15:03 2005
@@ -206,7 +206,9 @@
}
}
- /** Parse region elements. */
+ /** Parse region elements.
+ * @param props
+ */
protected void parseRegions( Properties props )
{
Enumeration en = props.propertyNames();
@@ -227,7 +229,12 @@
}
}
- /** Create cache region. */
+ /** Create cache region.
+ * @param props
+ * @param regName
+ * @param value
+ * @return CompositeCache
+ */
protected CompositeCache parseRegion( Properties props, String regName, String value )
{
return parseRegion( props, regName, value, null, REGION_PREFIX );
@@ -323,7 +330,11 @@
return cache;
}
- /** Get an compositecacheattributes for the listed region. */
+ /** Get an compositecacheattributes for the listed region.
+ * @param props
+ * @param regName
+ * @return
+ */
protected ICompositeCacheAttributes parseCompositeCacheAttributes( Properties props, String regName )
{
return parseCompositeCacheAttributes( props, regName, REGION_PREFIX );
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/CompositeCacheManager.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/CompositeCacheManager.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/CompositeCacheManager.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/CompositeCacheManager.java Wed Nov 9 18:15:03 2005
@@ -339,21 +339,33 @@
return getCache( cacheName, this.defaultCacheAttr.copy() );
}
- /** Gets the cache attribute of the CacheHub object */
+ /** Gets the cache attribute of the CacheHub object
+ * @param cacheName
+ * @param cattr
+ * @return*
+ */
public CompositeCache getCache( String cacheName, ICompositeCacheAttributes cattr )
{
cattr.setCacheName( cacheName );
return getCache( cattr, this.defaultElementAttr );
}
- /** Gets the cache attribute of the CacheHub object */
+ /** Gets the cache attribute of the CacheHub object
+ * @param cacheName
+ * @param cattr
+ * @param attr
+ * @return
+ */
public CompositeCache getCache( String cacheName, ICompositeCacheAttributes cattr, IElementAttributes attr )
{
cattr.setCacheName( cacheName );
return getCache( cattr, this.defaultElementAttr );
}
- /** Gets the cache attribute of the CacheHub object */
+ /** Gets the cache attribute of the CacheHub object
+ * @param cattr
+ * @return
+ */
public CompositeCache getCache( ICompositeCacheAttributes cattr )
{
return getCache( cattr, this.defaultElementAttr );
@@ -367,6 +379,9 @@
* the atributes are assigned to elements. Get cache creates a cache with
* defaults if none are specified. We might want to create separate method
* for creating/getting. . .
+ * @param cattr
+ * @param attr
+ * @return
*/
public CompositeCache getCache( ICompositeCacheAttributes cattr, IElementAttributes attr )
{
@@ -390,13 +405,18 @@
return cache;
}
- /** */
+ /**
+ * @param name
+ */
public void freeCache( String name )
{
freeCache( name, false );
}
- /** */
+ /**
+ * @param name
+ * @param fromRemote
+ */
public void freeCache( String name, boolean fromRemote )
{
CompositeCache cache = (CompositeCache) caches.remove( name );
@@ -448,7 +468,9 @@
release( false );
}
- /** */
+ /**
+ * @param fromRemote
+ */
private void release( boolean fromRemote )
{
synchronized ( CompositeCacheManager.class )
@@ -497,7 +519,9 @@
return list;
}
- /** */
+ /**
+ * @return
+ */
public int getCacheType()
{
return ICacheType.CACHE_HUB;
@@ -511,7 +535,8 @@
return this.defaultCacheAttr;
}
- /**
+ /**
+ * @param auxFac
*/
void registryFacPut( AuxiliaryCacheFactory auxFac )
{
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/event/behavior/IElementEventQueue.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/event/behavior/IElementEventQueue.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/event/behavior/IElementEventQueue.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/event/behavior/IElementEventQueue.java Wed Nov 9 18:15:03 2005
@@ -36,6 +36,7 @@
* The IElementEventHandler
* @param event
* The IElementEventHandler IElementEvent event
+ * @throws IOException
*/
public void addElementEvent( IElementEventHandler hand, IElementEvent event )
throws IOException;
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/group/GroupAttrName.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/group/GroupAttrName.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/group/GroupAttrName.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/group/GroupAttrName.java Wed Nov 9 18:15:03 2005
@@ -77,7 +77,10 @@
return groupId.hashCode() ^ attrName.hashCode();
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see java.lang.Object#toString()
+ */
public String toString()
{
if ( toString == null )
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/group/GroupId.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/group/GroupId.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/group/GroupId.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/control/group/GroupId.java Wed Nov 9 18:15:03 2005
@@ -54,7 +54,10 @@
}
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see java.lang.Object#equals(java.lang.Object)
+ */
public boolean equals( Object obj )
{
if ( obj == null || !( obj instanceof GroupId ) )
@@ -65,13 +68,19 @@
return cacheName.equals( g.cacheName ) && groupName.equals( g.groupName );
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see java.lang.Object#hashCode()
+ */
public int hashCode()
{
return cacheName.hashCode() + groupName.hashCode();
}
- /** Description of the Method */
+ /*
+ * (non-Javadoc)
+ * @see java.lang.Object#toString()
+ */
public String toString()
{
if ( toString == null )
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/AbstractMemoryCache.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/AbstractMemoryCache.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/AbstractMemoryCache.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/AbstractMemoryCache.java Wed Nov 9 18:15:03 2005
@@ -245,7 +245,7 @@
/**
* Puts an item to the cache.
*
- * @param me
+ * @param ce
* @exception IOException
*/
public void waterfal( ICacheElement ce )
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/lru/LRUMemoryCache.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/lru/LRUMemoryCache.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/lru/LRUMemoryCache.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/lru/LRUMemoryCache.java Wed Nov 9 18:15:03 2005
@@ -350,10 +350,15 @@
}
// --------------------------- iteration mehods (iteration helpers)
+ /**
+ *
+ * iteration aid
+ *
+ */
public class IteratorWrapper
implements Iterator
{
- private final Log log = LogFactory.getLog( LRUMemoryCache.class );
+ //private final Log log = LogFactory.getLog( LRUMemoryCache.class );
private final Iterator i;
@@ -457,7 +462,7 @@
* @param ce
* The feature to be added to the Last
*/
- private void addLast( CacheElement ce )
+ protected void addLast( CacheElement ce )
{
MemoryElementDescriptor me = new MemoryElementDescriptor( ce );
list.addLast( me );
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/util/DoubleLinkedList.java
URL: http://svn.apache.org/viewcvs/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/util/DoubleLinkedList.java?rev=332199&r1=332198&r2=332199&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/util/DoubleLinkedList.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/memory/util/DoubleLinkedList.java Wed Nov 9 18:15:03 2005
@@ -26,7 +26,7 @@
/**
* Adds a new node to the end of the link list.
*
- * @param ce
+ * @param me
* The feature to be added to the Last
*/
public void addLast( DoubleLinkedListNode me )
@@ -49,7 +49,7 @@
/**
* Adds a new node to the start of the link list.
*
- * @param ce
+ * @param me
* The feature to be added to the First
*/
public synchronized void addFirst( DoubleLinkedListNode me )
@@ -72,6 +72,7 @@
/**
* Removes the specified node from the link list.
+ * @return
*
*/
public DoubleLinkedListNode getLast()
@@ -85,6 +86,7 @@
/**
* Removes the specified node from the link list.
+ * @return
*
*/
public DoubleLinkedListNode getFirst()
@@ -99,7 +101,7 @@
/**
* Moves an existing node to the start of the link list.
*
- * @param me
+ * @param ln
* Description of the Parameter
*/
public synchronized void makeFirst( DoubleLinkedListNode ln )
@@ -154,6 +156,7 @@
*
* @param me
* Description of the Parameter
+ * @return
*/
public synchronized boolean remove( DoubleLinkedListNode me )
{
@@ -205,6 +208,7 @@
/**
* Removes the specified node from the link list.
+ * @return
*
*/
public DoubleLinkedListNode removeLast()
---------------------------------------------------------------------
To unsubscribe, e-mail: jcs-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jcs-dev-help@jakarta.apache.org