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

[Manik Surtani]

  User: msurtani
  Date: 07/07/28 06:00:17

  Modified:    src/org/jboss/cache  Cache.java
  Log:
  Better javadocs
  
  Revision  Changes    Path
  1.32      +7 -4      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.31
  retrieving revision 1.32
  diff -u -b -r1.31 -r1.32
  --- Cache.java	17 Jul 2007 14:52:18 -0000	1.31
  +++ Cache.java	28 Jul 2007 10:00:17 -0000	1.32
  @@ -256,7 +256,8 @@
   
      /**
       * Lifecycle method that starts the cache loader,
  -    * starts cache replication, starts the region manager, etc.
  +    * starts cache replication, starts the region manager, etc., and (if configured) warms the cache using a
  +    * state transfer or cache loader preload.
       *
       * @throws CacheException if there are startup problems
       */
  @@ -264,13 +265,15 @@
   
      /**
       * Lifecycle method that stops the cache, including replication,
  -    * clustering, cache loading, notifications, etc.
  +    * clustering, cache loading, notifications, etc., and clears all cache in-memory state.
  +    * <p/>
  +    * State can be reconstituted by using either a cache loader or state transfer when the cache starts again.
       */
      void stop();
   
      /**
  -    * Lifecycle method that clears state.
  -    * Cache can then be restarted using {@link #start}.
  +    * Lifecycle method that destroys the cache and removes any interceptors/configuration elements.
  +    * Cache can then be restarted (potentially after reconfiguring) using {@link #create()} and {@link #start()}.
       */
      void destroy();