avalon-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mcconn...@apache.org
Subject cvs commit: jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler ComponentHandler.java FactoryComponentHandler.java LEAwareComponentHandler.java PerThreadComponentHandler.java PoolableComponentHandler.java ProxyHelper.java ThreadSafeComponentHandler.java
Date Thu, 09 Jan 2003 12:27:14 GMT
mcconnell    2003/01/09 04:27:14

  Modified:    fortress/src/java/org/apache/excalibur/fortress/handler
                        ComponentHandler.java FactoryComponentHandler.java
                        LEAwareComponentHandler.java
                        PerThreadComponentHandler.java
                        PoolableComponentHandler.java ProxyHelper.java
                        ThreadSafeComponentHandler.java
  Log:
  javadoc
  
  Revision  Changes    Path
  1.24      +5 -3      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/ComponentHandler.java
  
  Index: ComponentHandler.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/ComponentHandler.java,v
  retrieving revision 1.23
  retrieving revision 1.24
  diff -u -r1.23 -r1.24
  --- ComponentHandler.java	10 Nov 2002 13:06:14 -0000	1.23
  +++ ComponentHandler.java	9 Jan 2003 12:27:14 -0000	1.24
  @@ -54,7 +54,7 @@
    * The desire for a ComponentHandler is to manage the instances of a
    * Component.
    *
  - * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  + * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
    * @version CVS $Revision$ $Date$
    * @since 4.0
    */
  @@ -64,7 +64,7 @@
        * Actually prepare the handler and make it ready to
        * handle component access.
        *
  -     * @throws Exception if unable to prepare handler
  +     * @exception Exception if unable to prepare handler
        */
       void prepareHandler()
           throws Exception;
  @@ -72,12 +72,14 @@
       /**
        * Gets the current reference to a Component according to the policy of
        * the implementation.
  +     * @exception Exception if unable to ge tthe compoennt reference
        */
       Object get() throws Exception;
   
       /**
        * Puts the reference back in the ComponentHandler according to the
        * policy of the implementation.
  +     * @param component the component to return to the handler
        */
       void put( Object component );
   }
  
  
  
  1.38      +4 -3      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/FactoryComponentHandler.java
  
  Index: FactoryComponentHandler.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/FactoryComponentHandler.java,v
  retrieving revision 1.37
  retrieving revision 1.38
  diff -u -r1.37 -r1.38
  --- FactoryComponentHandler.java	10 Nov 2002 11:40:31 -0000	1.37
  +++ FactoryComponentHandler.java	9 Jan 2003 12:27:14 -0000	1.38
  @@ -53,8 +53,7 @@
    * The FactoryComponentHandler to make sure components are initialized
    * and destroyed correctly.
    *
  - * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  - * @author <a href="mailto:crafterm@apache.org">Marcus Crafter</a>
  + * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
    * @version CVS $Revision$ $Date$
    * @since 4.0
    */
  @@ -63,6 +62,7 @@
   {
       /**
        * Get a reference of the desired Component
  +     * @exception Exception if arros occurs
        */
       protected Object doGet()
           throws Exception
  @@ -72,6 +72,7 @@
   
       /**
        * Return a reference of the desired Component
  +     * @param componet the compoent to return to the handler
        */
       protected void doPut( final Object component )
       {
  
  
  
  1.7       +14 -1     jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/LEAwareComponentHandler.java
  
  Index: LEAwareComponentHandler.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/LEAwareComponentHandler.java,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- LEAwareComponentHandler.java	4 Dec 2002 12:18:36 -0000	1.6
  +++ LEAwareComponentHandler.java	9 Jan 2003 12:27:14 -0000	1.7
  @@ -68,6 +68,12 @@
       private final LifecycleExtensionManager m_extManager;
       private final Context m_context;
   
  +   /**
  +    * Creation of a new handler.
  +    * @param componentHandler the handler
  +    * @param extManager the extension manager
  +    * @param context the context
  +    */
       public LEAwareComponentHandler( final ComponentHandler componentHandler,
                                       final LifecycleExtensionManager extManager,
                                       final Context context )
  @@ -90,6 +96,10 @@
           m_context = context;
       }
   
  +   /**
  +    * Prepare the handler.
  +    * @exception Exception if a handler preparation error occurs
  +    */
       public void prepareHandler()
           throws Exception
       {
  @@ -127,6 +137,9 @@
           m_componentHandler.put( component );
       }
   
  +   /**
  +    * Disposal of the handler.
  +    */
       public void dispose()
       {
           ContainerUtil.dispose( m_componentHandler );
  
  
  
  1.42      +2 -3      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/PerThreadComponentHandler.java
  
  Index: PerThreadComponentHandler.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/PerThreadComponentHandler.java,v
  retrieving revision 1.41
  retrieving revision 1.42
  diff -u -r1.41 -r1.42
  --- PerThreadComponentHandler.java	10 Nov 2002 12:00:17 -0000	1.41
  +++ PerThreadComponentHandler.java	9 Jan 2003 12:27:14 -0000	1.42
  @@ -52,8 +52,7 @@
    * The ThreadSafeComponentHandler to make sure components are initialized
    * and destroyed correctly.
    *
  - * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  - * @author <a href="mailto:crafterm@apache.org">Marcus Crafter</a>
  + * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
    * @version CVS $Revision$ $Date$
    * @since 4.0
    */
  
  
  
  1.45      +15 -3     jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/PoolableComponentHandler.java
  
  Index: PoolableComponentHandler.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/PoolableComponentHandler.java,v
  retrieving revision 1.44
  retrieving revision 1.45
  diff -u -r1.44 -r1.45
  --- PoolableComponentHandler.java	12 Nov 2002 04:04:57 -0000	1.44
  +++ PoolableComponentHandler.java	9 Jan 2003 12:27:14 -0000	1.45
  @@ -61,8 +61,7 @@
    * The PoolableComponentHandler to make sure components are initialized
    * and destroyed correctly.
    *
  - * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  - * @author <a href="mailto:crafterm@apache.org">Marcus Crafter</a>
  + * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
    * @version CVS $Revision$ $Date$
    * @since 4.0
    */
  @@ -80,6 +79,9 @@
       private int m_poolMin;
   
       /**
  +     * Application of suporting services to the handler.
  +     * @param serviceManager the service manager
  +     * @exception ServiceException if a service related error occurs
        * @avalon.dependency type="PoolManager"
        */
       public void service( final ServiceManager serviceManager )
  @@ -90,6 +92,13 @@
               (PoolManager)serviceManager.lookup( PoolManager.ROLE );
       }
   
  +   /**
  +    * Configuration of the handler under which the minimum pool size
  +    * is established.
  +    * @param configuration the configuration fragment
  +    * @exception configuration exception if the supplied configuration attribute 
  +    *    for 'pool-min' cannot be resolved to an integer value
  +    */
       public void configure( final Configuration configuration )
           throws ConfigurationException
       {
  @@ -98,6 +107,7 @@
   
       /**
        * Initialize the ComponentHandler.
  +     * @exception Exception if an error occurs
        */
       protected void doPrepare()
           throws Exception
  @@ -107,6 +117,7 @@
   
       /**
        * Get a reference of the desired Component
  +     * @exception Exception if an error occurs
        */
       protected Object doGet()
           throws Exception
  @@ -116,6 +127,7 @@
   
       /**
        * Return a reference of the desired Component
  +     * @param component the component to return to the handler
        */
       protected void doPut( final Object component )
       {
  
  
  
  1.5       +2 -0      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/ProxyHelper.java
  
  Index: ProxyHelper.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/ProxyHelper.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- ProxyHelper.java	3 Dec 2002 02:21:02 -0000	1.4
  +++ ProxyHelper.java	9 Jan 2003 12:27:14 -0000	1.5
  @@ -108,6 +108,8 @@
   
       /**
        * Get the Component wrapped in the proxy.
  +     * @param service the service object to proxy
  +     * @exception Exception if a proxy establishment error occurs
        */
       public static Component createProxy( Object service ) throws Exception
       {
  
  
  
  1.41      +4 -3      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/ThreadSafeComponentHandler.java
  
  Index: ThreadSafeComponentHandler.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/handler/ThreadSafeComponentHandler.java,v
  retrieving revision 1.40
  retrieving revision 1.41
  diff -u -r1.40 -r1.41
  --- ThreadSafeComponentHandler.java	10 Nov 2002 11:41:28 -0000	1.40
  +++ ThreadSafeComponentHandler.java	9 Jan 2003 12:27:14 -0000	1.41
  @@ -53,8 +53,7 @@
    * The ThreadSafeComponentHandler to make sure components are initialized
    * and destroyed correctly.
    *
  - * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  - * @author <a href="mailto:crafterm@apache.org">Marcus Crafter</a>
  + * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
    * @version CVS $Revision$ $Date$
    * @since 4.0
    */
  @@ -65,6 +64,7 @@
   
       /**
        * Initialize the ComponentHandler.
  +     * @exception Exception if a handler preparation error occurs
        */
       protected void doPrepare()
           throws Exception
  @@ -76,6 +76,7 @@
        * Return instance for a get.
        *
        * @return the instance
  +     * @exception Exception if a handler access error occurs
        */
       protected Object doGet()
           throws Exception
  
  
  

--
To unsubscribe, e-mail:   <mailto:avalon-cvs-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@jakarta.apache.org>


Mime
View raw message