You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by mc...@apache.org on 2003/01/09 13:53:25 UTC

cvs commit: jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/util ContextBuilder.java ContextManager.java OverridableContext.java

mcconnell    2003/01/09 04:53:25

  Modified:    fortress/src/java/org/apache/excalibur/fortress/lookup
                        FortressServiceSelector.java
               fortress/src/java/org/apache/excalibur/fortress/role
                        AbstractRoleManager.java
                        ConfigurableRoleManager.java
                        ExcaliburRoleManager.java RoleEntry.java
                        RoleManager.java
               fortress/src/java/org/apache/excalibur/fortress/util
                        ContextBuilder.java ContextManager.java
                        OverridableContext.java
  Log:
  javadoc and minor updates
  
  Revision  Changes    Path
  1.18      +7 -2      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/lookup/FortressServiceSelector.java
  
  Index: FortressServiceSelector.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/lookup/FortressServiceSelector.java,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- FortressServiceSelector.java	9 Nov 2002 23:38:29 -0000	1.17
  +++ FortressServiceSelector.java	9 Jan 2003 12:53:24 -0000	1.18
  @@ -61,7 +61,7 @@
    * a very simple abstraction, and makes it easy for the Container to manage
    * the references.
    *
  - * @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$
    */
   public class FortressServiceSelector
  @@ -71,6 +71,11 @@
       private final Container m_container;
       private final Map m_used;
   
  +   /**
  +    * Creation of  new service selector.
  +    * @param container the container
  +    * @param key a key
  +    */
       public FortressServiceSelector( final Container container,
                                       final String key )
       {
  
  
  
  1.6       +17 -3     jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/role/AbstractRoleManager.java
  
  Index: AbstractRoleManager.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/role/AbstractRoleManager.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- AbstractRoleManager.java	12 Dec 2002 19:47:27 -0000	1.5
  +++ AbstractRoleManager.java	9 Jan 2003 12:53:25 -0000	1.6
  @@ -58,7 +58,7 @@
    * The Excalibur Role Manager is used for Excalibur Role Mappings.  All of
    * the information is hard-coded.
    *
  - * @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.1
    */
  @@ -66,6 +66,9 @@
       extends AbstractLogEnabled
       implements RoleManager
   {
  +   /**
  +    * The classloader
  +    */
       private final ClassLoader m_loader;
   
       /**
  @@ -121,6 +124,13 @@
           m_parent = parent;
       }
   
  +   /**
  +    * Addition of a role to the role manager.
  +    * @param shortName the shor name for the role
  +    * @param role the role
  +    * @param classname the class name
  +    * @param handlerClassName the handler classname
  +    */
       protected void addRole( final String shortName,
                               final String role,
                               final String className,
  @@ -177,7 +187,6 @@
           return PerThreadComponentHandler.class;
       }
   
  -
       public RoleEntry getRoleForClassname( final String classname )
       {
           final RoleEntry roleEntry = (RoleEntry)m_classnames.get( classname );
  @@ -195,6 +204,11 @@
           }
       }
   
  +   /**
  +    * Return a role name relative to a supplied short name
  +    * @param shortname the short name
  +    * @return the role entry
  +    */
       public RoleEntry getRoleForShortName( final String shortname )
       {
           final RoleEntry roleEntry = (RoleEntry)m_shorthands.get( shortname );
  
  
  
  1.5       +4 -3      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/role/ConfigurableRoleManager.java
  
  Index: ConfigurableRoleManager.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/role/ConfigurableRoleManager.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- ConfigurableRoleManager.java	11 Nov 2002 01:03:06 -0000	1.4
  +++ ConfigurableRoleManager.java	9 Jan 2003 12:53:25 -0000	1.5
  @@ -59,7 +59,7 @@
    * from a configuration hierarchy.  This is based on the DefaultRoleManager
    * in the org.apache.avalon.component package.
    *
  - * @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.1
    */
  @@ -90,7 +90,8 @@
        * Alternate constructor--this RoleManager has the specified
        * parent and a classloader.
        *
  -     * @param parent  The parent <code>RoleManager</code>.
  +     * @param parent The parent <code>RoleManager</code>.
  +     * @param loader the classloader
        */
       public ConfigurableRoleManager( RoleManager parent, ClassLoader loader )
       {
  
  
  
  1.4       +3 -3      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/role/ExcaliburRoleManager.java
  
  Index: ExcaliburRoleManager.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/role/ExcaliburRoleManager.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- ExcaliburRoleManager.java	10 Nov 2002 16:16:43 -0000	1.3
  +++ ExcaliburRoleManager.java	9 Jan 2003 12:53:25 -0000	1.4
  @@ -55,8 +55,7 @@
    * The Excalibur Role Manager is used for Excalibur Role Mappings.  All of
    * the information is hard-coded.
    *
  - * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  - * @author <a href="mailto:proyal@apache.org">Peter Royal</a>
  + * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
    * @version CVS $Revision$ $Date$
    * @since 4.1
    */
  @@ -88,6 +87,7 @@
        * parent and a classloader.
        *
        * @param parent  The parent <code>RoleManager</code>.
  +     * @param loader  the classloader
        */
       public ExcaliburRoleManager( RoleManager parent, ClassLoader loader )
       {
  
  
  
  1.3       +4 -4      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/role/RoleEntry.java
  
  Index: RoleEntry.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/role/RoleEntry.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- RoleEntry.java	12 Dec 2002 19:39:57 -0000	1.2
  +++ RoleEntry.java	9 Jan 2003 12:53:25 -0000	1.3
  @@ -13,7 +13,7 @@
    * the handler class used to manage it.  The short name is included strictly
    * to enable "self-healing" configuration files.
    *
  - * @author <a href="mailto:peter at apache.org">Peter Donald</a>
  + * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
    * @version $Revision$ $Date$
    */
   public class RoleEntry
  @@ -34,13 +34,13 @@
        * @param  handlerClass    <code>Class</code> to instantiate the
        *                         component handler
        *
  -     * @throws <code>IllegalArgumentException</code> if any argument is
  +     * @exception <code>IllegalArgumentException</code> if any argument is
        *         <code>null</code>.
        */
       public RoleEntry( final String role,
                         final String shortName,
                         final Class componentClass,
  -                      final Class handlerClass )
  +                      final Class handlerClass ) throws IllegalArgumentException
       {
           if( null == role )
           {
  
  
  
  1.6       +2 -3      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/role/RoleManager.java
  
  Index: RoleManager.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/role/RoleManager.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- RoleManager.java	12 Dec 2002 19:39:57 -0000	1.5
  +++ RoleManager.java	9 Jan 2003 12:53:25 -0000	1.6
  @@ -56,8 +56,7 @@
    * classes to roles.  Any one role can have multiple classes associated with
    * it.
    *
  - * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  - * @author <a href="mailto:peter at apache.org">Peter Donald</a>
  + * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
    * @version CVS $Revision$ $Date$
    * @since 4.1
    */
  
  
  
  1.32      +5 -0      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/util/ContextBuilder.java
  
  Index: ContextBuilder.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/util/ContextBuilder.java,v
  retrieving revision 1.31
  retrieving revision 1.32
  diff -u -r1.31 -r1.32
  --- ContextBuilder.java	10 Nov 2002 23:22:27 -0000	1.31
  +++ ContextBuilder.java	9 Jan 2003 12:53:25 -0000	1.32
  @@ -61,6 +61,8 @@
   
   /**
    * Helper class to create a context for the ContextManager.
  + * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
  + * @version CVS $Revision$ $Date$
    */
   public class ContextBuilder
       implements ContextManagerConstants
  @@ -98,6 +100,7 @@
   
       /**
        * Creates a default context.
  +     * @return a context
        */
       public static final Context createDefaultContext()
       {
  @@ -106,6 +109,7 @@
   
       /**
        * Creates a default context.
  +     * @return a context
        */
       public static final Context createDefaultContext( ClassLoader classLoader )
       {
  @@ -114,6 +118,7 @@
   
       /**
        * Finalizes the context and returns it.
  +     * @return a context
        */
       public Context getContext()
       {
  
  
  
  1.56      +6 -6      jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/util/ContextManager.java
  
  Index: ContextManager.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/util/ContextManager.java,v
  retrieving revision 1.55
  retrieving revision 1.56
  diff -u -r1.55 -r1.56
  --- ContextManager.java	27 Nov 2002 10:40:39 -0000	1.55
  +++ ContextManager.java	9 Jan 2003 12:53:25 -0000	1.56
  @@ -112,10 +112,7 @@
    * component m_manager, a pool m_manager, etc. It will manage these components
    * and dispose of them properly when it itself is disposed .</p>
    *
  - * @author <a href="mailto:bloritsch@apache.org">Berin Loritsch</a>
  - * @author <a href="mailto:leo.sutic@inspireinfrastructure.com">Leo Sutic</a>
  - * @author <a href="mailto:proyal@apache.org">Peter Royal</a>
  - * @author <a href="mailto:leif@apache.org">Leif Mortenson</a>
  + * @author <a href="mailto:avalon-dev@jakarta.apache.org">Avalon Development Team</a>
    * @version CVS $Revision$ $Date$
    * @since 4.1
    */
  @@ -657,7 +654,10 @@
           }
           catch( Exception e )
           {
  -            getLogger().warn( "Could not read configuration file: " + configUri, e );
  +            if( getLogger().isWarnEnabled() )
  +            {
  +                getLogger().warn( "Could not read configuration file: " + configUri, e );
  +            }
               return null;
           }
           finally
  
  
  
  1.13      +11 -2     jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/util/OverridableContext.java
  
  Index: OverridableContext.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/java/org/apache/excalibur/fortress/util/OverridableContext.java,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- OverridableContext.java	10 Nov 2002 09:17:25 -0000	1.12
  +++ OverridableContext.java	9 Jan 2003 12:53:25 -0000	1.13
  @@ -56,18 +56,27 @@
    * The OverridableContext allows you to "null" out entries, even if they are
    * in a parent context.
    *
  - * @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.1
    */
   public final class OverridableContext
       extends DefaultContext
   {
  +   /**
  +    * Creation of a new overridable context.
  +    * @param parent the parent context
  +    */
       public OverridableContext( Context parent )
       {
           super( parent );
       }
   
  +   /**
  +    * Add a context entry to the context.
  +    * @param key the context key
  +    * @param value the context value
  +    */
       public void put( final Object key, final Object value )
       {
           if( null == value )
  
  
  

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