mcconnell 2002/12/20 19:46:46
Modified: assembly/src/java/org/apache/avalon/assembly/appliance
Appliance.java
Log:
Doc updates.
Revision Changes Path
1.12 +30 -30
avalon-sandbox/assembly/src/java/org/apache/avalon/assembly/appliance/Appliance.java
Index: Appliance.java
===================================================================
RCS file:
/home/cvs/avalon-sandbox/assembly/src/java/org/apache/avalon/assembly/appliance/Appliance.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- Appliance.java 21 Dec 2002 03:28:37 -0000 1.11
+++ Appliance.java 21 Dec 2002 03:46:46 -0000 1.12
@@ -106,7 +106,7 @@
/**
* Return the component type backing the appliance.
- * @return the type that this appliance is managing
+ * @return the type that the appliance is managing
*/
Type getType();
@@ -161,6 +161,19 @@
*/
Configuration getConfiguration();
+ /**
+ * Return the context directive for the profile. A context directive
+ * is declared in a component profile and may contain information
+ * unabling the selection of a component implementation class and
+ * constructed context values. This information may be used by the
+ * the context management framework during creation and population
+ * of the of the context supplied to the target component.
+ *
+ * @return the ContextDirective for the profile.
+ * @see #getDeploymentContext()
+ */
+ ContextDirective getContextDirective();
+
/**
* Get the deployment context. The deployment context includes
* supplimentary context values provided by the client that can be
@@ -173,17 +186,11 @@
Map getDeploymentContext();
/**
- * Return the context directive for the profile. A context directive
- * is declared in a component profile and may contain information
- * unabling the selection of a component implementation class and
- * constructed context values. This information may be used by the
- * the context management framework during creation and population
- * of the of the context supplied to the target component.
+ * Set the context provider.
*
- * @return the ContextDirective for the profile.
- * @see #getDeploymentContext()
+ * @param applaince the appliance to be mapped as provider of the context
*/
- ContextDirective getContextDirective();
+ void setContextProvider( Appliance appliance );
/**
* Return the context provider.
@@ -193,11 +200,11 @@
Appliance getContextProvider();
/**
- * Set the context provider.
- *
- * @param applaince the appliance to be mapped as provider of the context
+ * Add the appliance that will acts as provider for a named dependency.
+ * @param role the role against which the supplied appliance is to be associated
+ * @param appliance the appliance that will fulfill the provider dependency
*/
- void setContextProvider( Appliance appliance );
+ void addServiceProvider( String role, Appliance appliance );
/**
* Return the dependency associations for component type with specified role.
@@ -214,18 +221,11 @@
Appliance[] getServiceProviders();
/**
- * Add the appliance that will acts as provider for a named dependency.
- * @param role the role against which the supplied appliance is to be associated
- * @param appliance the appliance that will fulfill the provider dependency
- */
- void addServiceProvider( String role, Appliance appliance );
-
- /**
- * Return the assigned extension providers.
- *
- * @return the set of extension provider appliances.
+ * Add a lifecycle stage extension.
+ * @param stage the identifier of the stage to assign the manager to
+ * @param appliance the appliance that will handle the stage
*/
- Appliance[] getExtensionProviders();
+ void addExtensionProvider( StageDescriptor stage, Appliance appliance );
/**
* Returns the appliace assigned to handle the components lifecycle stage.
@@ -235,11 +235,11 @@
Appliance getExtensionProvider( StageDescriptor stage );
/**
- * Add a lifecycle stage extension.
- * @param stage the identifier of the stage to assign the manager to
- * @param appliance the appliance that will handle the stage
+ * Return the assigned extension providers.
+ *
+ * @return the set of extension provider appliances.
*/
- void addExtensionProvider( StageDescriptor stage, Appliance appliance );
+ Appliance[] getExtensionProviders();
/**
* Creation of a instance of the component type managed by the appliance
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
