cvs commit: jakarta-avalon-excalibur/fortress/src/ng/org/apache/excalibur/fortress/util AssemblyMap.java

[mc...@apache.org]

mcconnell    2002/11/11 06:46:12

  Modified:    fortress/src/ng/org/apache/excalibur/fortress/util
                        AssemblyMap.java
  Log:
  javadoc corrections and updates
  
  Revision  Changes    Path
  1.2       +12 -2     jakarta-avalon-excalibur/fortress/src/ng/org/apache/excalibur/fortress/util/AssemblyMap.java
  
  Index: AssemblyMap.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/fortress/src/ng/org/apache/excalibur/fortress/util/AssemblyMap.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- AssemblyMap.java	8 Nov 2002 06:06:12 -0000	1.1
  +++ AssemblyMap.java	11 Nov 2002 14:46:12 -0000	1.2
  @@ -56,19 +56,23 @@
    * The AssemblyMap takes care of the mapping logic for the assembly files.  The
    * assembly file format is the same for all AssemblyMaps to allow for a system
    * to upgrade from static mapping (where all mappings *must* be provided) to
  - * dynmic mapping (where a mapping will be generated if it does not exist).
  + * dynamic mapping (where a mapping will be generated if it does not exist).
    */
   public interface AssemblyMap
   {
       /**
        * Get the name that this particular Type is bound to for a configuration
        * file.  It assists in "self-healing" configuration files.
  +     * @param type the component type
  +     * @return the name fo the component type
        */
  -    String getNameForType( Type component );
  +    String getNameForType( Type type );
   
       /**
        * Get the Type boud to a particular name for a configuration file.  It
        * assists in "self-healing" configuration files.
  +     * @param name the component type name
  +     * @return the component type
        */
       Type getTypeForName( String name );
   
  @@ -77,11 +81,16 @@
        * particular Type.  It helps the AssemblyMap return the proper Type
        * reference for the dependency since different components may have different
        * mappings.
  +     * @param dependency the dependency descriptor 
  +     * @param forType the type descriptor
  +     * @return the component type
        */
       Type getMappedType( DependencyDescriptor dependency, Type forType );
   
       /**
        * Get the Type that is mapped to a particular DependencyDescriptor.
  +     * @param dependency the dependency descriptor
  +     * @return the component type
        */
       Type getMappedType( DependencyDescriptor dependency );
   
  @@ -90,6 +99,7 @@
        * work.  They are made to evaluate the system once the components are loaded.
        * If any of the required services are not loaded, we can use the
        * DependencyDescriptor to find the best solution.
  +     * @return an array of depedency descriptors
        */
       DependencyDescriptor[] getRequiredServices();
   }
  
  
  

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