mcconnell 2002/06/10 19:16:38
Modified: containerkit/src/java/org/apache/excalibur/containerkit/metadata
ComponentMetaData.java DependencyMetaData.java
Log:
javadoc updates
Revision Changes Path
1.2 +13 -12
jakarta-avalon-excalibur/containerkit/src/java/org/apache/excalibur/containerkit/metadata/ComponentMetaData.java
Index: ComponentMetaData.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/containerkit/src/java/org/apache/excalibur/containerkit/metadata/ComponentMetaData.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ComponentMetaData.java 4 Jun 2002 07:46:53 -0000 1.1
+++ ComponentMetaData.java 11 Jun 2002 02:16:38 -0000 1.2
@@ -18,31 +18,32 @@
* new Components as needed.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
+ * @author <a href="mailto:[EMAIL PROTECTED]">Stephen McConnell</a>
* @version $Revision$ $Date$
*/
public class ComponentMetaData
{
/**
- * The name of the Component. This is an abstract name
- * used during assembly.
+ * The name of the component metadata instance. This is an
+ * abstract name used during assembly.
*/
private final String m_name;
/**
* The resolution of any dependencies required by
- * the component.
+ * the component type.
*/
private final DependencyMetaData[] m_dependencies;
/**
- * The info object for component.
+ * The info object for component type.
*/
private final ComponentInfo m_info;
/**
* Create a ComponentMetaData.
*
- * @param name the name of component
+ * @param name the abstract name of component meta data instance
* @param dependencies the meta data for any dependencies
* @param info the info for component
*/
@@ -56,7 +57,7 @@
}
/**
- * Return the name of component.
+ * Return the name of component metadata instance.
*
* @return the name of the component.
*/
@@ -66,11 +67,11 @@
}
/**
- * Utility method to return the classname of component.
+ * Utility method to return the classname of component type.
* This is equivelent to
* <tt>getComponentInfo().getComponentDescriptor().getClassname()</tt>.
*
- * @return the classname of the component.
+ * @return the classname of the component type.
*/
public String getClassname()
{
@@ -80,7 +81,7 @@
/**
* Return the info for component.
*
- * @return the info for component.
+ * @return the info for component type.
*/
public ComponentInfo getComponentInfo()
{
@@ -88,7 +89,7 @@
}
/**
- * Return the dependency metadata for component.
+ * Return the dependency metadata for component type.
*
* @return the dependency metadata for component.
*/
@@ -98,7 +99,7 @@
}
/**
- * Return the dependency metadata for component with specified role.
+ * Return the dependency metadata for component type with specified role.
*
* @return the dependency metadata for component with specified role.
*/
1.2 +12 -6
jakarta-avalon-excalibur/containerkit/src/java/org/apache/excalibur/containerkit/metadata/DependencyMetaData.java
Index: DependencyMetaData.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-excalibur/containerkit/src/java/org/apache/excalibur/containerkit/metadata/DependencyMetaData.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DependencyMetaData.java 4 Jun 2002 07:46:53 -0000 1.1
+++ DependencyMetaData.java 11 Jun 2002 02:16:38 -0000 1.2
@@ -17,17 +17,19 @@
* <p>Note that it is invalid to have circular dependencies.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
+ * @author <a href="mailto:[EMAIL PROTECTED]">Stephen McConnell</a>
* @version $Revision$ $Date$
*/
public final class DependencyMetaData
{
/**
- * The name that the client component will use to access dependency.
+ * The name that the client component will use to access a dependency.
*/
private final String m_role;
/**
- * the name of the Component that will provide the dependency.
+ * the name of the component metadata instance that represents a
component
+ * type that is capable of fullfilling the dependency.
*/
private final String m_name;
@@ -35,7 +37,8 @@
* Create MetaData with specified name and role.
*
* @param role the name client uses to access component
- * @param name the name of provider
+ * @param name the name of <code>ComponentMetaData</code> instance
+ * that is associated as a service provider
*/
public DependencyMetaData( final String role, final String name )
{
@@ -44,9 +47,11 @@
}
/**
- * Return the name that the client component will use to access
dependency.
+ * Return the name 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.ServiceManager.lookup( String )
*/
public String getRole()
{
@@ -54,7 +59,8 @@
}
/**
- * Return the name of the Component that will provide the dependency.
+ * Return the name of a <code>ComponentMetaData</code> instance that
will used to
+ * fulfill the dependency.
*
* @return the name of the Component that will provide the dependency.
*/
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
