[infinispan-commits] Infinispan SVN: r1300 - trunk/core/src/main/java/org/infinispan/manager.

[infinispan-commits at lists.jboss.org]

Author: manik.surtani at jboss.com
Date: 2009-12-15 07:39:11 -0500 (Tue, 15 Dec 2009)
New Revision: 1300

Modified:
   trunk/core/src/main/java/org/infinispan/manager/CacheManager.java
Log:
Updated Javadocs

Modified: trunk/core/src/main/java/org/infinispan/manager/CacheManager.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/manager/CacheManager.java	2009-12-15 12:25:18 UTC (rev 1299)
+++ trunk/core/src/main/java/org/infinispan/manager/CacheManager.java	2009-12-15 12:39:11 UTC (rev 1300)
@@ -42,6 +42,10 @@
  * When the system shuts down, it should call {@link #stop()} on the <tt>CacheManager</tt>.  This will ensure all caches
  * within its scope are properly stopped as well.
  * <p/>
+ * <b>NB:</b> Shared caches are supported (and in fact encouraged) but if they are used it's the users responsibility to
+ * ensure that <i>at least one</i> but <i>only one</i> caller calls stop() on the cache, and it does so with the awareness
+ * that others may be using the cache.
+ * <p />
  * Sample usage: <code> CacheManager manager = new DefaultCacheManager("my-config-file.xml"); Cache entityCache =
  * manager.getCache("myEntityCache"); entityCache.put("aPerson", new Person());
  * <p/>
@@ -106,6 +110,10 @@
     * Retrieves the default cache associated with this cache manager.
     * <p/>
     * As such, this method is always guaranteed to return the default cache.
+    * <p />
+    * <b>NB:</b> Shared caches are supported (and in fact encouraged) but if they are used it's the users responsibility to
+    * ensure that <i>at least one</i> but <i>only one</i> caller calls stop() on the cache, and it does so with the awareness
+    * that others may be using the cache.
     *
     * @return the default cache.
     */
@@ -119,6 +127,10 @@
     * as a template, and then optionally apply any overrides previously defined for the named cache using the {@link
     * #defineConfiguration(String, Configuration)} or {@link #defineConfiguration(String, String, Configuration)}
     * methods, or declared in the configuration file.
+    * <p />
+    * <b>NB:</b> Shared caches are supported (and in fact encouraged) but if they are used it's the users responsibility to
+    * ensure that <i>at least one</i> but <i>only one</i> caller calls stop() on the cache, and it does so with the awareness
+    * that others may be using the cache.
     *
     * @param cacheName name of cache to retrieve
     * @return a cache instance identified by cacheName