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

[infinispan-commits at lists.jboss.org]

Author: manik.surtani at jboss.com
Date: 2010-01-06 13:21:38 -0500 (Wed, 06 Jan 2010)
New Revision: 1348

Modified:
   trunk/core/src/main/java/org/infinispan/Cache.java
Log:
Javadoc

Modified: trunk/core/src/main/java/org/infinispan/Cache.java
===================================================================
--- trunk/core/src/main/java/org/infinispan/Cache.java	2010-01-06 18:18:43 UTC (rev 1347)
+++ trunk/core/src/main/java/org/infinispan/Cache.java	2010-01-06 18:21:38 UTC (rev 1348)
@@ -49,6 +49,10 @@
  * For convenience, Cache extends {@link ConcurrentMap} and implements all methods accordingly, although methods like
  * {@link ConcurrentMap#keySet()}, {@link ConcurrentMap#values()} and {@link ConcurrentMap#entrySet()} are expensive
  * (prohibitively so when using a distributed cache) and frequent use of these methods is not recommended.
+ * <p /> 
+ * Other methods such as {@link #size()} provide an approximation-only, and should not be relied on for an accurate picture
+ * as to the size of the entire, distributed cache.  Remote nodes are <i>not</i> queried and in-fly transactions are not
+ * taken into account, even if {@link #size()} is invoked from within such a transaction.
  * <p/>
  * Also, like many {@link ConcurrentMap} implementations, Cache does not support the use of <tt>null</tt> keys or
  * values.