Author: manik.surtani(a)jboss.com
Date: 2008-11-10 06:39:16 -0500 (Mon, 10 Nov 2008)
New Revision: 7102
Modified:
core/trunk/src/main/java/org/jboss/cache/config/Option.java
Log:
Corrected Javadocs
Modified: core/trunk/src/main/java/org/jboss/cache/config/Option.java
===================================================================
--- core/trunk/src/main/java/org/jboss/cache/config/Option.java 2008-11-10 10:17:39 UTC
(rev 7101)
+++ core/trunk/src/main/java/org/jboss/cache/config/Option.java 2008-11-10 11:39:16 UTC
(rev 7102)
@@ -360,7 +360,11 @@
}
/**
- * Forces a write lock to be acquired on the call, regardless of whether it is a read
or write. Only applies to the {@link
org.jboss.cache.interceptors.PessimisticLockInterceptor}
+ * Forces a write lock to be acquired on the call, regardless of whether it is a read
or write.
+ * <p />
+ * Note that this only applies to {@link
org.jboss.cache.config.Configuration.NodeLockingScheme#MVCC} and {@link
org.jboss.cache.config.Configuration.NodeLockingScheme#PESSIMISTIC}
+ * node locking schemes, and is ignored if {@link
org.jboss.cache.config.Configuration.NodeLockingScheme#OPTIMISTIC} is used.
+ * <p />
*
* @param forceWriteLock
* @since 2.0.0
@@ -372,7 +376,11 @@
/**
- * Tests whether a write lock has been forced on the call, regardless of whether it is
a read or write. Only applies to the {@link
org.jboss.cache.interceptors.PessimisticLockInterceptor}
+ * Tests whether a write lock has been forced on the call, regardless of whether it is
a read or write.
+ * <p />
+ * Note that this only applies to {@link
org.jboss.cache.config.Configuration.NodeLockingScheme#MVCC} and {@link
org.jboss.cache.config.Configuration.NodeLockingScheme#PESSIMISTIC}
+ * node locking schemes, and is ignored if {@link
org.jboss.cache.config.Configuration.NodeLockingScheme#OPTIMISTIC} is used.
+ * <p />
*
* @since 2.0.0
*/
Show replies by date