[jboss-cvs] JBossAS SVN: r104978 - projects/jboss-classpool/trunk/classpool/src/main/java/org/jboss/classpool/base.

[jboss-cvs-commits at lists.jboss.org]

Author: kabir.khan at jboss.com
Date: 2010-05-19 07:07:34 -0400 (Wed, 19 May 2010)
New Revision: 104978

Modified:
   projects/jboss-classpool/trunk/classpool/src/main/java/org/jboss/classpool/base/CtClassCacheFactory.java
Log:
Better comments

Modified: projects/jboss-classpool/trunk/classpool/src/main/java/org/jboss/classpool/base/CtClassCacheFactory.java
===================================================================
--- projects/jboss-classpool/trunk/classpool/src/main/java/org/jboss/classpool/base/CtClassCacheFactory.java	2010-05-19 09:49:17 UTC (rev 104977)
+++ projects/jboss-classpool/trunk/classpool/src/main/java/org/jboss/classpool/base/CtClassCacheFactory.java	2010-05-19 11:07:34 UTC (rev 104978)
@@ -31,7 +31,27 @@
 import org.jboss.util.TimedCachePolicy;
 
 /**
+ * if <code>-Dorg.jboss.classpool.policy<code> is not set, no caching will be used in the classpools.
+ * It can be set to the name of any <code>org.jboss.util.CachePolicy</code> implementation
+ * with a default constructor. Two <code>CachePolicy</code> implementations
+ * supported out of the box with extra properties are 
+ * <ul>
+ *   <li><code>org.jboss.util.LRUCachePolicy</code> - A least recently used cache policy with the following properties
+ *      <ul>
+ *        <li><code>-Dorg.jboss.classpool.policy.min</code> - the minimum size of the cache. Default is 10</li>
+ *        <li><code>-Dorg.jboss.classpool.policy.max</code> - the maximum size of the cache. Default is 100</li>
+ *      </ul> 
+ *   </li>
+ *   <li><code>org.jboss.util.TimedCachePolicy</code> - A timed cache policy with the following properties
+ *      <ul>
+ *        <li><code>-Dorg.jboss.classpool.policy.lifetime</code> - the maximum age in seconds for an entry in the cache. Default is 20s</li>
+ *        <li><code>-Dorg.jboss.classpool.policy.resolution</code> - the frequency in seconds the entries are cleaned. Default is every 3 seconds</li>
+ *      </ul> 
+ *   </li>
+ *   <li><code></code></li>
+ * </ul>
  * 
+ * 
  * @author <a href="kabir.khan at jboss.com">Kabir Khan</a>
  * @version $Revision: 1.1 $
  */