donaldp 2002/06/03 18:08:34
Modified: src/java/org/apache/avalon/phoenix/components/lifecycle/metainfo
DependencyDescriptor.java
Log:
Add some javadocs more explaining dependency
descriptor. Also indicate that in the future
we may be adding other constraints to
descriptor.
Revision Changes Path
1.2 +23 -8
jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/lifecycle/metainfo/DependencyDescriptor.java
Index: DependencyDescriptor.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/lifecycle/metainfo/DependencyDescriptor.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DependencyDescriptor.java 4 Jun 2002 00:46:21 -0000 1.1
+++ DependencyDescriptor.java 4 Jun 2002 01:08:34 -0000 1.2
@@ -8,13 +8,31 @@
package org.apache.avalon.phoenix.components.lifecycle.metainfo;
/**
- * A descriptor that describes dependency information for Block.
+ * A descriptor that describes dependency information for
+ * a particular Component. This class contains information
+ * about;
+ * <ul>
+ * <li>role: the name component uses to look up dependency</li>
+ * <li>service: the class/interface that the dependency must provide</li>
+ * </ul>
+ *
+ * <p>Note that in the future we may also add information relating to
+ * constraints on dependency. ie The dependency must be configured in
+ * particular fashion or must be able to provide certain facilities etc</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Peter Donald</a>
+ * @version $Revision: 1.2 $ $Date: 2002/06/04 01:08:34 $
*/
public final class DependencyDescriptor
{
+ /**
+ * The name the component uses to lookup dependency.
+ */
private final String m_role;
+
+ /**
+ * The service class/interface that the dependency must provide.
+ */
private final ServiceDescriptor m_service;
/**
@@ -27,12 +45,9 @@
}
/**
- * Return role of dependency.
- *
- * The role is what is used by block implementor to
- * aquire dependency in ComponentManager.
+ * Return the name the component uses to lookup dependency.
*
- * @return the name of the dependency
+ * @return the name the component uses to lookup dependency.
*/
public String getRole()
{
@@ -40,9 +55,9 @@
}
/**
- * Return Service dependency provides.
+ * Return the service class/interface that the dependency must provide.
*
- * @return the service dependency provides
+ * @return the service class/interface that the dependency must provide.
*/
public ServiceDescriptor getService()
{
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
