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

[Jason Thomas Greene]

  User: jgreene 
  Date: 07/05/30 16:58:58

  Modified:    src/org/jboss/cache/pojo  PojoCache.java
  Log:
  Add some more doc
  
  Revision  Changes    Path
  1.4       +13 -9     JBossCache/src/org/jboss/cache/pojo/PojoCache.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: PojoCache.java
  ===================================================================
  RCS file: /cvsroot/jboss/JBossCache/src/org/jboss/cache/pojo/PojoCache.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -b -r1.3 -r1.4
  --- PojoCache.java	30 May 2007 06:08:01 -0000	1.3
  +++ PojoCache.java	30 May 2007 20:58:57 -0000	1.4
  @@ -125,16 +125,20 @@
      void destroy() throws PojoCacheException;
   
      /**
  -    * Add a PojoCacheListener
  +    * Add a PojoCacheListener. A given listener instance can only be added once.
  +    * To have a duplicate listener simply create a new instance.
       *
  -    * @param listener
  +    * @param listener the listener instance to register
       */
      void addListener(PojoCacheListener listener);
      
      /**
  -    * Add a PojoCacheListener
  +    * Add a PojoCacheListener that will only monitor a specific ID(FQN) pattern.
  +    * A given listener instance can only be added once, whether or not there is
  +    * a pattern. To have a duplicate listener simply create a new instance.
       *
  -    * @param listener
  +    * @param listener the listener instance to register
  +    * @param pattern the ID pattern for notifications of interest
       */
      void addListener(PojoCacheListener listener, Pattern pattern);
   
  @@ -146,7 +150,7 @@
      /**
       * Remove the specific listener.
       *
  -    * @param listener
  +    * @param listener the listener to remove
       */
      void removeListener(PojoCacheListener listener);