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

[Manik S. <msu...@jb...>]

  User: msurtani
  Date: 06/07/10 10:58:53

  Modified:    src/org/jboss/cache/config  Option.java
  Log:
  merged in changes from 1.4.0
  
  Revision  Changes    Path
  1.7       +9 -7      JBossCache/src/org/jboss/cache/config/Option.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: Option.java
  ===================================================================
  RCS file: /cvsroot/jboss/JBossCache/src/org/jboss/cache/config/Option.java,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -b -r1.6 -r1.7
  --- Option.java	1 Jun 2006 19:04:52 -0000	1.6
  +++ Option.java	10 Jul 2006 14:58:53 -0000	1.7
  @@ -9,7 +9,7 @@
   import org.jboss.cache.optimistic.DataVersion;
   
   /**
  - * Used to override characteristics of specific calls to the cache.
  + * Used to override characteristics of specific calls to the cache.  The javadocs of each of the setters below detail functionality and behaviour.
    *
    * @author <a href="mailto:ma...@jb...">Manik Surtani (ma...@jb...)</a>
    * @since 1.3.0
  @@ -18,6 +18,7 @@
   {
       private boolean failSilently;
       private boolean cacheModeLocal;
  +    private DataVersion dataVersion;
       private boolean suppressLocking;    
       private boolean forceDataGravitation;
   
  @@ -31,7 +32,7 @@
       }
   
       /**
  -     *
  +     * Suppresses acquiring locks for the given invocation.  Used with pessimistic locking only.  Use with extreme care, may lead to a breach in data integrity!
        * @since 1.4.0
        */
       public void setSuppressLocking(boolean suppressLocking)
  @@ -39,7 +40,6 @@
           this.suppressLocking = suppressLocking;
       }
   
  -    private DataVersion dataVersion;
   
       /**
        *
  @@ -51,7 +51,7 @@
       }
   
       /**
  -     *
  +     * suppress any failures in your cache operation, including version mismatches with optimistic locking, timeouts obtaining locks, transaction rollbacks.  If this is option is set, the method invocation will __never fail or throw an exception__, although it may not succeed.  With this option enabled the call will <b>not</b> participate in any ongoing transactions even if a transaction is running.
        * @since 1.3.0
        */
       public void setFailSilently(boolean failSilently)
  @@ -69,7 +69,7 @@
       }
   
       /**
  -     * only applies to put() and remove() methods on the cache.
  +     * overriding CacheMode from REPL_SYNC, REPL_ASYNC, INVALIDATION_SYNC, INVALIDATION_ASYNC to LOCAL.  Only applies to put() and remove() methods on the cache.
        * @since 1.3.0
        * @param cacheModeLocal
        */
  @@ -88,7 +88,7 @@
       }
   
       /**
  -     *
  +     * Passing in an {@link org.jboss.cache.optimistic.DataVersion} instance when using optimistic locking will override the default behaviour of internally generated version info and allow the caller to handle data versioning.
        * @since 1.3.0
        */
       public void setDataVersion(DataVersion dataVersion)
  @@ -106,7 +106,9 @@
      }
   
      /**
  -    *
  +    * Enables data gravitation calls if a cache miss is detected when using <a href="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossCacheBuddyReplicationDesign">Buddy Replication</a>.
  +    * Enabled only for a given invocation, and only useful if <code>autoDataGravitation</code> is set to <code>false</code>.
  +    * See <a href="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossCacheBuddyReplicationDesign">Buddy Replication</a> documentation for more details.
       * @since 1.4.0
       */
      public void setForceDataGravitation(boolean enableDataGravitation)