[jboss-cvs] JBossCache/src/org/jboss/cache ...

[Manik Surtani]

  User: msurtani
  Date: 07/03/15 21:11:58

  Modified:    src/org/jboss/cache  Cache.java
  Log:
  Updated javadocs for putForExternalRead()
  
  Revision  Changes    Path
  1.27      +5 -2      JBossCache/src/org/jboss/cache/Cache.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: Cache.java
  ===================================================================
  RCS file: /cvsroot/jboss/JBossCache/src/org/jboss/cache/Cache.java,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -b -r1.26 -r1.27
  --- Cache.java	12 Mar 2007 18:13:46 -0000	1.26
  +++ Cache.java	16 Mar 2007 01:11:58 -0000	1.27
  @@ -153,10 +153,11 @@
      /**
       * Under special operating behavior, associates the value with the specified key for a node identified by the Fqn passed in.
       * <ul>
  +    * <li> Only goes through if the node specified does not exist; no-op otherwise.</i>
  +    * <li> Force asynchronous mode for replication or invalidation to prevent any blocking.</li>
  +    * <li> 0ms lock timeout to prevent any blocking here either. If the lock is not acquired, this method is a no-op, and swallows the timeout exception.</li>
       * <li> Ongoing transactions are suspended before this call, so failures here will not affect any ongoing transactions.</li>
       * <li> Errors and exceptions are 'silent' - logged at a much lower level than normal, and this method does not throw exceptions</li>
  -    * <li> Lock acquisition timeouts are dropped to 0 to improve performance</li>
  -    * <li> If pessimistic locking is used, write locks are not obtained here - even though this is a write.  Instead, read locks are used.<li>
       * </ul>
       * This method is for caching data that has an external representation in storage, where, concurrent modification and
       * transactions are not a consideration, and failure to put the data in the cache should be treated as a 'suboptimal outcome'
  @@ -166,6 +167,8 @@
       * returning the data to the caller.  Subsequent calls would prefer to get the data from the cache and if the data doesn't exist
       * in the cache, fetch again from the legacy datastore.
       * <p/>
  +    * See <a href="http://jira.jboss.com/jira/browse/JBCACHE-848">JBCACHE-848</a> for details around this feature.
  +    * <p/>
       *
       * @param fqn   <b><i>absolute</i></b> {@link Fqn} to the {@link Node} to be accessed.
       * @param key   key with which the specified value is to be associated.