Author: asmuts
Date: Wed Aug 13 15:21:15 2008
New Revision: 685707
URL: http://svn.apache.org/viewvc?rev=685707&view=rev
Log:
fixing some formatting and javadocs
Modified:
jakarta/jcs/trunk/ (props changed)
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/AbstractAuxiliaryCacheAttributes.java
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/behavior/IRemoteCacheAttributes.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheAdaptor.java
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheElementSerialized.java
Propchange: jakarta/jcs/trunk/
------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Wed Aug 13 15:21:15 2008
@@ -10,3 +10,4 @@
CodeWrestler.excludes
*.ser
.settings
+aaronsmuts
Modified:
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/AbstractAuxiliaryCacheAttributes.java
URL:
http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/AbstractAuxiliaryCacheAttributes.java?rev=685707&r1=685706&r2=685707&view=diff
==============================================================================
---
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/AbstractAuxiliaryCacheAttributes.java
(original)
+++
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/AbstractAuxiliaryCacheAttributes.java
Wed Aug 13 15:21:15 2008
@@ -17,22 +17,22 @@
import org.apache.jcs.engine.behavior.ICacheEventQueue;
-/*
+/**
* This has common attributes used by all auxiliaries.
*/
public abstract class AbstractAuxiliaryCacheAttributes
implements AuxiliaryCacheAttributes
{
- /** Don't change */
+ /** Don't change */
private static final long serialVersionUID = -6594609334959187673L;
/** cacheName */
protected String cacheName;
- /** name */
+ /** name */
protected String name;
- /** eventQueueType -- pooled or single threaded */
+ /** eventQueueType -- pooled or single threaded */
protected int eventQueueType;
/** Named when pooled */
@@ -77,12 +77,9 @@
}
/**
- * SINGLE is the default. If you choose POOLED, the value of
- * EventQueuePoolName will be used
+ * SINGLE is the default. If you choose POOLED, the value of
EventQueuePoolName will be used
* <p>
- * @param s
- * SINGLE or POOLED
- * @return
+ * @param s SINGLE or POOLED
*/
public void setEventQueueType( String s )
{
@@ -131,12 +128,10 @@
}
/**
- * If you choose a POOLED event queue type, the value of EventQueuePoolName
- * will be used. This is ignored if the pool type is SINGLE
+ * If you choose a POOLED event queue type, the value of
EventQueuePoolName will be used. This
+ * is ignored if the pool type is SINGLE
* <p>
- * @param s
- * SINGLE or POOLED
- * @return
+ * @param s SINGLE or POOLED
*/
public void setEventQueuePoolName( String s )
{
@@ -144,8 +139,8 @@
}
/**
- * Sets the pool name to use. If a pool is not found by this name, the
- * thread pool manager will return a default configuration.
+ * Sets the pool name to use. If a pool is not found by this name, the
thread pool manager will
+ * return a default configuration.
* <p>
* @return name of thread pool to use for this auxiliary
*/
Modified:
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/behavior/IRemoteCacheAttributes.java
URL:
http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/behavior/IRemoteCacheAttributes.java?rev=685707&r1=685706&r2=685707&view=diff
==============================================================================
---
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/behavior/IRemoteCacheAttributes.java
(original)
+++
jakarta/jcs/trunk/src/java/org/apache/jcs/auxiliary/remote/behavior/IRemoteCacheAttributes.java
Wed Aug 13 15:21:15 2008
@@ -27,14 +27,10 @@
public interface IRemoteCacheAttributes
extends AuxiliaryCacheAttributes
{
- /**
- * A remote cache is either a local cache or a cluster cache.
- */
+ /** A remote cache is either a local cache or a cluster cache. */
public static final int LOCAL = 0;
- /**
- * A remote cache is either a local cache or a cluster cache.
- */
+ /** A remote cache is either a local cache or a cluster cache. */
public static final int CLUSTER = 1;
/** The default timeout for the custom RMI socket facfory */
@@ -246,7 +242,7 @@
* <p>
* The default name is "remote_cache_client"
* <p>
- * @return
+ * @return the name of the pool
*/
public abstract String getThreadPoolName();
@@ -261,7 +257,7 @@
* -1 and 0 mean no timeout, this is the default if the timeout is -1 or
0, no threadpool will
* be used.
* <p>
- * @return
+ * @return the time in millis
*/
public abstract int getGetTimeoutMillis();
@@ -284,7 +280,7 @@
public abstract int getRmiSocketFactoryTimeoutMillis();
/**
- * This sets a general timeout on the rmi socket factory. By default the
socket factory will
+ * This sets a general timeout on the RMI socket factory. By default the
socket factory will
* block forever.
* <p>
* @param rmiSocketFactoryTimeoutMillis
@@ -321,7 +317,7 @@
/**
* The number of elements the zombie queue will hold. This queue is used
to store events if we
- * loose our conenction with the server.
+ * loose our connection with the server.
* <p>
* @param zombieQueueMaxSize The zombieQueueMaxSize to set.
*/
@@ -329,7 +325,7 @@
/**
* The number of elements the zombie queue will hold. This queue is used
to store events if we
- * loose our conenction with the server.
+ * loose our connection with the server.
* <p>
* @return Returns the zombieQueueMaxSize.
*/
Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheAdaptor.java
URL:
http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheAdaptor.java?rev=685707&r1=685706&r2=685707&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 Aug
13 15:21:15 2008
@@ -39,7 +39,7 @@
private final ICache cache;
- /** The unique id of this listner. */
+ /** The unique id of this listener. */
protected long listenerId = 0;
/**
@@ -70,6 +70,7 @@
/**
* Constructor for the CacheAdaptor object
+ * <p>
* @param cache
*/
public CacheAdaptor( ICache cache )
@@ -96,10 +97,12 @@
}
}
- /*
- * (non-Javadoc)
- * @see
org.apache.jcs.engine.behavior.ICacheListener#handleRemove(java.lang.String,
- * java.io.Serializable)
+ /**
+ * Removes an item.
+ * <p>
+ * @param cacheName
+ * @param key
+ * @throws IOException
*/
public void handleRemove( String cacheName, Serializable key )
throws IOException
@@ -107,9 +110,11 @@
cache.remove( key );
}
- /*
- * (non-Javadoc)
- * @see
org.apache.jcs.engine.behavior.ICacheListener#handleRemoveAll(java.lang.String)
+ /**
+ * Clears the region.
+ * <p>
+ * @param cacheName
+ * @throws IOException
*/
public void handleRemoveAll( String cacheName )
throws IOException
@@ -117,9 +122,11 @@
cache.removeAll();
}
- /*
- * (non-Javadoc)
- * @see
org.apache.jcs.engine.behavior.ICacheListener#handleDispose(java.lang.String)
+ /**
+ * Shutdown call.
+ * <p>
+ * @param cacheName
+ * @throws IOException
*/
public void handleDispose( String cacheName )
throws IOException
Modified:
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheElementSerialized.java
URL:
http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheElementSerialized.java?rev=685707&r1=685706&r2=685707&view=diff
==============================================================================
---
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheElementSerialized.java
(original)
+++
jakarta/jcs/trunk/src/java/org/apache/jcs/engine/CacheElementSerialized.java
Wed Aug 13 15:21:15 2008
@@ -39,6 +39,7 @@
/** This is the cache key by which the value can be referenced. */
private final Serializable key;
+ /** The serialized value. */
private final byte[] serializedValue;
/**
@@ -66,6 +67,8 @@
/**
* Returns the name of the cache. This is the name of the region.
+ * <p>
+ * @return this.cacheName;
*/
public String getCacheName()
{
@@ -118,6 +121,8 @@
/**
* For debugging only.
+ * <p>
+ * @return debugging string.
*/
public String toString()
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
