[jbosscache-commits] JBoss Cache SVN: r6198 - core/trunk/src/main/java/org/jboss/cache/factories/annotations.

[jbosscache-commits at lists.jboss.org]

Author: manik.surtani at jboss.com
Date: 2008-07-07 16:50:09 -0400 (Mon, 07 Jul 2008)
New Revision: 6198

Modified:
   core/trunk/src/main/java/org/jboss/cache/factories/annotations/NonVolatile.java
Log:
Better documented

Modified: core/trunk/src/main/java/org/jboss/cache/factories/annotations/NonVolatile.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/factories/annotations/NonVolatile.java	2008-07-07 20:19:19 UTC (rev 6197)
+++ core/trunk/src/main/java/org/jboss/cache/factories/annotations/NonVolatile.java	2008-07-07 20:50:09 UTC (rev 6198)
@@ -8,7 +8,9 @@
 /**
  * This annotation is used for components that will be registered in the {@link org.jboss.cache.factories.ComponentRegistry},
  * that are resilient to changes in configuration.  Examples are the {@link org.jboss.cache.CacheSPI} implementation used, which does
- * not change regardless of the configuration.
+ * not change regardless of the configuration.  Components such as the {@link org.jboss.cache.lock.LockManager}, though, should
+ * <b>never</b> be marked as <tt>@NonVolatile</tt> since based on the configuration, different lock manager implementations
+ * may be selected.  LockManager is, hence, <b>not</b> resilient to changes in the configuration.
  *
  * @author Manik Surtani (<a href="mailto:manik at jboss.org">manik at jboss.org</a>)
  * @since 2.2.0