cvs commit: jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool Poolable.java

[do...@apache.org]

donaldp     02/02/13 13:09:16

  Modified:    src/java/org/apache/avalon/excalibur/pool Poolable.java
  Log:
  Added a bunch more documentation.
  
  Submitted By: Mark Woon <mo...@SMI.Stanford.EDU>
  
  Revision  Changes    Path
  1.5       +33 -8     jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool/Poolable.java
  
  Index: Poolable.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/src/java/org/apache/avalon/excalibur/pool/Poolable.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- Poolable.java	11 Dec 2001 09:53:32 -0000	1.4
  +++ Poolable.java	13 Feb 2002 21:09:16 -0000	1.5
  @@ -8,17 +8,42 @@
   package org.apache.avalon.excalibur.pool;
   
   /**
  - * Poolable marker interface.
  - *
  - * Components implement this interface if it is reasonable to
  - * Pool the object. Components that don't implement this interface
  - * will be created anew via a factory.
  - *
  - * NB: It was a deliberat e choice not to extend Component. This will have to
  + * <code>Poolable</code> is a marker interface for Components that can
  + * be pooled.  Components that are not pooled are created anew via a
  + * factory every time a request is made for the component.
  + * <p>
  + * Components implementing this interface can add the following
  + * attributes to its definition:
  + * <pre><code>
  + *   &lt;component pool-min="1" pool-max="10" pool-grow="1"&gt;
  + *     &lt;tag&gt;value&lt;/tag&gt;
  + *   &lt;/component&gt;
  + * </pre></code>
  + * Where:
  + * <table border="0" cellpadding="4" cellspacing="0">
  + *   <tr>
  + *     <td valign="top"><code>pool-min</code></td>
  + *     <td valign="top">sets the minimum number of Components maintained by the
  + *     pool</td>
  + *   </tr>
  + *   <tr>
  + *     <td valign="top"><code>pool-max</code></td>
  + *     <td valign="top">sets the maximum number of Components maintained by the
  + *     pool</td>
  + *   </tr>
  + *   <tr>
  + *     <td valign="top"><code>pool-grow</code></td>
  + *     <td valign="top">sets the number of Components to grow or
  + *     shrink the pool by whenever it becomes necessary to do so</td>
  + *   </tr>
  + * </table>
  + * </p><p>
  + * NB: It was a deliberate choice not to extend Component. This will have to
    * be reassed once we see it in action.
  + * </p>
    *
    * @author <a href="mailto:peter@apache.org">Peter Donald</a>
  - * @version CVS $Revision: 1.4 $ $Date: 2001/12/11 09:53:32 $
  + * @version CVS $Revision: 1.5 $ $Date: 2002/02/13 21:09:16 $
    * @since 4.0
    */
   public interface Poolable
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>