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/containerkit/src/java/org/apache/excalibur/containerkit/infobuilder ComponentInfoBuilder.java package.html
Date Sun, 23 Jun 2002 14:09:26 GMT
mcconnell    2002/06/23 07:09:26

  Modified:    containerkit/src/java/org/apache/excalibur/containerkit/infobuilder
                        ComponentInfoBuilder.java package.html
  Log:
  javadoc updating
  
  Revision  Changes    Path
  1.4       +3 -2      jakarta-avalon-excalibur/containerkit/src/java/org/apache/excalibur/containerkit/infobuilder/ComponentInfoBuilder.java
  
  Index: ComponentInfoBuilder.java
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/containerkit/src/java/org/apache/excalibur/containerkit/infobuilder/ComponentInfoBuilder.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- ComponentInfoBuilder.java	23 Jun 2002 02:57:00 -0000	1.3
  +++ ComponentInfoBuilder.java	23 Jun 2002 14:09:26 -0000	1.4
  @@ -27,9 +27,10 @@
   /**
    * A ComponentInfoBuilder is responsible for building {@link ComponentInfo}
    * objects from Configuration objects. The format for Configuration object
  - * is specified in the ComponentInfo specification.
  + * is specified in the <a href="package-summary.html#external">package summary</a>.
    *
    * @author <a href="mailto:peter@apache.org">Peter Donald</a>
  + * @author <a href="mailto:mcconnell@apache.org">Stephen McConnell</a>
    * @version $Revision$ $Date$
    */
   public final class ComponentInfoBuilder
  
  
  
  1.2       +148 -1    jakarta-avalon-excalibur/containerkit/src/java/org/apache/excalibur/containerkit/infobuilder/package.html
  
  Index: package.html
  ===================================================================
  RCS file: /home/cvs/jakarta-avalon-excalibur/containerkit/src/java/org/apache/excalibur/containerkit/infobuilder/package.html,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- package.html	23 Jun 2002 02:45:37 -0000	1.1
  +++ package.html	23 Jun 2002 14:09:26 -0000	1.2
  @@ -1,3 +1,150 @@
   <html><body>
  -Component information builder.
  +<p>Component information builder that based on internalization of an component type
description supplied as a configuration instance.</P>
  +
  +<a name="external"><h3>External Form (XML)</h3></a>
  +<p>Configuration instances supplied to the builder shall correspond to the following
structure:</p>
  +
  +<pre>
  +
  +<font color="gray"><i>&lt;!--
  +Example of a component meta info external XML form. 
  +The element contains the information required to construct an instance of
  +org.apache.excalibur.containerkit.metainfo.ComponentInfo.  It includes 
  +information about the component type, the service it provides, and the 
  +services it is dependent on.
  +--&gt;</i></font>
  +
  +&lt;component-info&gt;
  +
  +
  +  <font color="gray"><i>&lt;!--
  +  Defintion of a single component descriptor.
  +  --&gt;</i></font>
  +
  +  &lt;component&gt;
  +
  +    <font color="gray"><i>&lt;!-- the name of the component (character
restriction appply) --&gt;</i></font>
  +
  +    &lt;name&gt;<font color="darkred">my-component</font>&lt;name&gt;
  +
  +    <font color="gray"><i>&lt;!-- the implementation version --&gt;</i></font>
  +
  +    &lt;version&gt;</strong><font color="darkred">1.2.1</font>&lt;/version&gt;
  +
  +    <font color="gray"><i>&lt;!-- the set of attribibutes associated with
the type
  +         (attribute names and values are examples only) --&gt;</i></font>
  +
  +    &lt;attributes&gt;
  +
  +       &lt;attribute key="<font color="darkred">avalon:display-name-i18n</font>"
value="<font color="darkred">display-name</font>"/&gt;
  +       &lt;attribute key="<font color="darkred">avalon:lifestyle</font>"
value="<font color="darkred">THREAD_SAFE</font>"/&gt;
  +
  +    &lt;/attributes&gt;
  +
  +  &lt;/component&gt;
  +
  +  <font color="gray"><i>&lt;!-- 
  +  Declaration of the context constraints for the compoent type. 
  +  The "type" attribute is the name of an interface derived from the default
  +  contenxt interface org.apache.avalon.framework.context.Context 
  +  --&gt;</i></font>
  +
  +  &lt;context type="<font color="darkred">MyContextInterface</font>"&gt;
  +
  +    <font color="gray"><i>&lt;!-- 
  +    Declaration of an entry in a context object, the "key" is
  +    the key used by a component to locate the context entry,
  +    the "type" is the classname of value (typically an interface)
  +    or primative type.  The default value is java.lang.String.
  +    The "optional" attribute is a boolean value derived from the 
  +    TRUE or FALSE that indicates if the context value must be 
  +    provided or not (default is FALSE). 
  +    --&gt;</i></font>
  +
  +    &lt;entry key="<font color="darkred">base</font>" type="<font color="darkred">java.io.File</font>"/&gt;
  +    &lt;entry key="<font color="darkred">mode</font>" optional="<font
color="darkred">TRUE</font>"/&gt;
  +
  +  &lt;/context&gt;
  +
  +  <font color="gray"><i>&lt;!--
  +  Declaration of the set of services that this component is capable 
  +  of supplying.  Each service declarared under the services element
  +  may be referenced by other component info descriptions as a 
  +  dependecy.  A container is responsible for the assemably of 
  +  components based on the connection of supply components to 
  +  consumer components via a common service description. 
  +  --&gt;</i></font>
  +
  +  &lt;services&gt;
  +
  +      <font color="gray"><i>&lt;!-- 
  +      The service type is the classname of an interface and the
  +      version identifier qualifes the interface version.  The 
  +      default version value is 1.0.
  +      --&gt;</i></font>
  +
  +      &lt;service type="<font color="darkred">SimpleService</font>" version="<font
color="darkred">3.2</font>"&gt;
  +
  +        &lt;attributes&gt;
  +
  +           <font color="gray"><i>&lt;!--
  +           Service type attributes go here.
  +           Need some relevant examples. 
  +           --&gt;</i></font>
  +
  +        &lt;/attributes&gt;
  +
  +      &lt;/service&gt;
  +
  +  &lt;/services&gt;
  +
  +
  +  <font color="gray"><i>&lt;!-- 
  +  Declaration of the set of dependecies that this component type has on 
  +  component suppliers.  Dependecy declarations define the role name name
  +  that a consumer component will use to access a service via a service
  +  or component manager.  The service element identifies a service 
  +  descriptor that is publised by a potential supplier component. 
  +  --&gt;</i></font>
  +
  +  &lt;dependencies&gt;
  +
  +    <font color="gray"><i>&lt;!-- A dependecy declaration. --&gt;</i></font>
  +
  +    &lt;dependency&gt;
  +
  +      <font color="gray"><i>&lt;!-- 
  +      The role name that the component will use as the argument to 
  +      lookup. The default value is the value of the service type 
  +      attribute listed below.
  +      --&gt;</i></font>
  +
  +      &lt;role&gt;<font color="darkred">my-transformer</font>&lt;/role&gt;
  +
  +      <font color="gray"><i>&lt;!-- 
  +      service reference containing the classname of the service interface
  +      and the version value where version defaults to 1.0 
  +      --&gt;</i></font>
  +
  +      &lt;service type="<font color="darkred">org.apache.cocoon.api.Transformer</font>"
version="<font color="darkred">1.1</font>"/&gt;
  +
  +      <font color="gray"><i>&lt;!-- the set of attributes associated with
the dependecy --&gt;</i></font>
  +
  +      &lt;attributes&gt;
  +
  +           <font color="gray"><i>&lt;!-- 
  +           Service type constraints go here.
  +           Need some relevant examples. 
  +           --&gt;</i></font>
  +
  +      &lt;/attributes&gt;
  +
  +    &lt;/dependency&gt;
  +
  +  &lt;/dependencies&gt;
  +
  +&lt;/component-info&gt;
  +
  +</pre>
  +
   </body></html>
  
  
  

--
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