CVS: jcontainer/loom/engine/src/java/org/jcontainer/loom/components/util/metadata ComponentTemplate.java,1.1,1.2 DependencyDirective.java,1.1,1.2 MetaDataBuilder.java,1.2,1.3 PartitionTemplate.java,1.1,1.2
Peter Donald <pdonald-yCVjj/[email protected]> Sat, 29 Nov 2003 07:44:59 -0600
| Newsgroups | gmane.comp.java.jcontainer.cvs |
|---|---|
| Message-ID | <[email protected]> |
Update of /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/util/metadata
In directory hogshead.codehaus.org:/tmp/cvs-serv31016/loom/engine/src/java/org/jcontainer/loom/components/util/metadata
Modified Files:
ComponentTemplate.java DependencyDirective.java
MetaDataBuilder.java PartitionTemplate.java
Log Message:
Remove email addie
Index: ComponentTemplate.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/util/metadata/ComponentTemplate.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- ComponentTemplate.java 3 Nov 2003 06:43:15 -0000 1.1
+++ ComponentTemplate.java 29 Nov 2003 13:44:26 -0000 1.2
@@ -13,66 +13,58 @@
import org.jcontainer.dna.Configuration;
/**
- * Each component declared in the application is represented by
- * a ComponentTemplate. Note that this does not necessarily imply
- * that there is only one instance of actual component. The
- * ComponentTemplate could represent a pool of components, a single
- * component or a component prototype that is reused to create
- * new components as needed.
+ * Each component declared in the application is represented by a
+ * ComponentTemplate. Note that this does not necessarily imply that there is
+ * only one instance of actual component. The ComponentTemplate could represent
+ * a pool of components, a single component or a component prototype that is
+ * reused to create new components as needed.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
*/
public class ComponentTemplate
{
- /**
- * Empty set of component metadata.
- */
+ /** Empty set of component metadata. */
public static final ComponentTemplate[] EMPTY_SET = new ComponentTemplate[ 0 ];
/**
- * The name of the component. This is an
- * abstract name used during assembly.
+ * The name of the component. This is an abstract name used during
+ * assembly.
*/
private final String m_name;
/**
- * The implementationKey for this component.
- * Usually this represents a classname but
- * alternative mechanisms could be used (ie URL
- * of webservice).
+ * The implementationKey for this component. Usually this represents a
+ * classname but alternative mechanisms could be used (ie URL of
+ * webservice).
*/
private final String m_implementationKey;
/**
- * The resolution of any dependencies required by
- * the component type.
+ * The resolution of any dependencies required by the component type.
*/
private final DependencyDirective[] m_dependencies;
- /**
- * The parameters for component (if any).
- */
+ /** The parameters for component (if any). */
private final Parameters m_parameters;
- /**
- * The configuration for component (if any).
- */
+ /** The configuration for component (if any). */
private final Configuration m_configuration;
- /**
- * True if proxy should be disabled.
- */
+ /** True if proxy should be disabled. */
private final boolean m_disableProxy;
/**
* Create a ComponentTemplate.
*
* @param name the abstract name of component meta data instance
- * @param implementationKey the key used to create component (usually a classname)
+ * @param implementationKey the key used to create component (usually a
+ * classname)
* @param dependencies the meta data for any dependencies
- * @param parameters the parameters that the component will be provided (may be null)
- * @param configuration the configuration that the component will be provided (may be null)
+ * @param parameters the parameters that the component will be provided (may
+ * be null)
+ * @param configuration the configuration that the component will be
+ * provided (may be null)
* @param disableProxy true if proxy should be disabled
*/
public ComponentTemplate( final String name,
@@ -182,7 +174,8 @@
}
/**
- * Return all the dependencies for key. Used for Map and array dependencies.
+ * Return all the dependencies for key. Used for Map and array
+ * dependencies.
*
* @return all the dependencies for key
*/
Index: DependencyDirective.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/util/metadata/DependencyDirective.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- DependencyDirective.java 3 Nov 2003 06:43:15 -0000 1.1
+++ DependencyDirective.java 29 Nov 2003 13:44:26 -0000 1.2
@@ -87,39 +87,35 @@
package org.jcontainer.loom.components.util.metadata;
/**
- * The DependencyDirective is the mapping of a component as a dependency
- * of another component. Each component declares dependencies (via
- * ComponentInfo) and for each dependency there must be a coressponding
- * DependencyDirective which has a matching key. The name value in
- * DependencyDirective object must refer to another Component that implements
- * a service as specified in DependencyInfo.
+ * The DependencyDirective is the mapping of a component as a dependency of
+ * another component. Each component declares dependencies (via ComponentInfo)
+ * and for each dependency there must be a coressponding DependencyDirective
+ * which has a matching key. The name value in DependencyDirective object must
+ * refer to another Component that implements a service as specified in
+ * DependencyInfo.
*
* <p>Note that it is invalid to have circular dependencies.</p>
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
*/
public final class DependencyDirective
{
- /**
- * Empty set of dependencys.
- */
+ /** Empty set of dependencys. */
public static final DependencyDirective[] EMPTY_SET = new DependencyDirective[ 0 ];
- /**
- * The key that the client component will use to access a dependency.
- */
+ /** The key that the client component will use to access a dependency. */
private final String m_key;
/**
- * the name of the component profile that represents a component
- * type that is capable of fullfilling the dependency.
+ * the name of the component profile that represents a component type that
+ * is capable of fullfilling the dependency.
*/
private final String m_providerName;
/**
- * The key that is used when the dependency is a map dependency.
- * Usually this defaults to the same value as the key.
+ * The key that is used when the dependency is a map dependency. Usually
+ * this defaults to the same value as the key.
*/
private final String m_alias;
@@ -127,12 +123,12 @@
* Create Association between key and provider.
*
* @param key the key the client uses to access component
- * @param providerName the name of ComponentTemplate
- * that is associated as a service provider
+ * @param providerName the name of ComponentTemplate that is associated as a
+ * service provider
*/
public DependencyDirective( final String key,
- final String providerName,
- final String alias )
+ final String providerName,
+ final String alias )
{
if( null == key )
{
@@ -155,8 +151,10 @@
* Return the key that will be used by a component instance to access a
* dependent service.
*
- * @return the name that the client component will use to access dependency.
- * @see org.apache.avalon.framework.service.ServiceManager#lookup( java.lang.String )
+ * @return the name that the client component will use to access
+ * dependency.
+ * @see org.apache.avalon.framework.service.ServiceManager#lookup(
+ * java.lang.String )
*/
public String getKey()
{
@@ -164,8 +162,8 @@
}
/**
- * Return the name of a ComponentTemplate instance that will used to
- * fulfill the dependency.
+ * Return the name of a ComponentTemplate instance that will used to fulfill
+ * the dependency.
*
* @return the name of the Component that will provide the dependency.
*/
@@ -175,11 +173,11 @@
}
/**
- * The key under which the dependency is placed in map if dependency is
- * a Map dependency.
+ * The key under which the dependency is placed in map if dependency is a
+ * Map dependency.
*
- * @return the key under which the dependency is placed in map if dependency is
- * a Map dependency.
+ * @return the key under which the dependency is placed in map if dependency
+ * is a Map dependency.
*/
public String getAlias()
{
Index: MetaDataBuilder.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/util/metadata/MetaDataBuilder.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -d -r1.2 -r1.3
--- MetaDataBuilder.java 3 Nov 2003 06:43:15 -0000 1.2
+++ MetaDataBuilder.java 29 Nov 2003 13:44:26 -0000 1.3
@@ -5,28 +5,28 @@
* Software License version 1.1, a copy of which has been included
* with this distribution in the LICENSE.txt file.
*/
- package org.jcontainer.loom.components.util.metadata;
+package org.jcontainer.loom.components.util.metadata;
import java.util.Map;
/**
- * Load metadata for an Assembly from some source.
- * The source is usually one or more xml config files.
+ * Load metadata for an Assembly from some source. The source is usually one or
+ * more xml config files.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
*/
public interface MetaDataBuilder
{
/**
- * Load metadata from a particular source
- * using specified map of parameters. The content
- * of the parameters is left unspecified.
+ * Load metadata from a particular source using specified map of parameters.
+ * The content of the parameters is left unspecified.
*
- * @param parameters the parameters indicating method to load meta data source
+ * @param parameters the parameters indicating method to load meta data
+ * source
* @return the set of components in metadata
- * @throws java.lang.Exception if unable to load or resolve
- * meta data for any reason
+ * @throws java.lang.Exception if unable to load or resolve meta data for
+ * any reason
*/
PartitionTemplate buildAssembly( Map parameters )
throws Exception;
Index: PartitionTemplate.java
===================================================================
RCS file: /cvsroot/jcontainer/jcontainer/loom/engine/src/java/org/jcontainer/loom/components/util/metadata/PartitionTemplate.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- PartitionTemplate.java 3 Nov 2003 06:43:15 -0000 1.1
+++ PartitionTemplate.java 29 Nov 2003 13:44:26 -0000 1.2
@@ -7,49 +7,40 @@
*/
package org.jcontainer.loom.components.util.metadata;
-
-
/**
- * In each Assembly there may be groups of components that
- * are activated together and treated as a group. These
- * components are all "visible" to each other as peers.
- * The group will have a name and may use resources from
- * other partitions. Partitions can also be nested one inside
- * each other.
+ * In each Assembly there may be groups of components that are activated
+ * together and treated as a group. These components are all "visible" to each
+ * other as peers. The group will have a name and may use resources from other
+ * partitions. Partitions can also be nested one inside each other.
*
- * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
+ * @author Peter Donald
* @version $Revision$ $Date$
*/
public class PartitionTemplate
{
- /**
- * Constant for an empty set of partitions.
- */
+ /** Constant for an empty set of partitions. */
public static final PartitionTemplate[] EMPTY_SET = new PartitionTemplate[ 0 ];
/**
- * The name of the partition. This is an
- * abstract name used during assembly.
+ * The name of the partition. This is an abstract name used during
+ * assembly.
*/
private final String m_name;
/**
- * An array listing the set of other partitions required by
- * this partition. The required partitions must be initialized
- * and in ready state prior to this partition starting and this
- * partition must be shutdown prior
+ * An array listing the set of other partitions required by this partition.
+ * The required partitions must be initialized and in ready state prior to
+ * this partition starting and this partition must be shutdown prior
*/
private final String[] m_depends;
/**
- * AN array of partitions that are contained by this
- * object.
+ * AN array of partitions that are contained by this object.
*/
private final PartitionTemplate[] m_partitions;
/**
- * AN array of components that are contained by this
- * object.
+ * AN array of components that are contained by this object.
*/
private final ComponentTemplate[] m_components;