svn commit: r953586 - in /felix/trunk/dependencymanager: annotation/src/main/java/org/apache/felix/dm/annotation/api/ServiceDependency.java runtime/src/main/java/org/apache/felix/dm/runtime/ServiceLifecycleHandler.java

[pderop]

Author: pderop
Date: Fri Jun 11 07:18:23 2010
New Revision: 953586

URL: http://svn.apache.org/viewvc?rev=953586&view=rev
Log:
fixed javadoc

Modified:
    
felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ServiceDependency.java
    
felix/trunk/dependencymanager/runtime/src/main/java/org/apache/felix/dm/runtime/ServiceLifecycleHandler.java

Modified: 
felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ServiceDependency.java
URL: 
http://svn.apache.org/viewvc/felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ServiceDependency.java?rev=953586&r1=953585&r2=953586&view=diff
==============================================================================
--- 
felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ServiceDependency.java
 (original)
+++ 
felix/trunk/dependencymanager/annotation/src/main/java/org/apache/felix/dm/annotation/api/ServiceDependency.java
 Fri Jun 11 07:18:23 2010
@@ -108,6 +108,40 @@ public @interface ServiceDependency
     /**
      * Sets the dependency name. This attribute is only meaningful when 
dynamically configuring the dependency 
      * <code>filter</code> and <code>required</code> flag from the Service's 
init method.
+     * 
+     * Usage Example of a Service whose dependency filter is configured from 
ConfigAdmin:
+     * 
+     * <blockquote><pre>
+     *  &#47;**
+     *    * A Service whose service dependency filter/require attribute may be 
configured from ConfigAdmin
+     *    *&#47;
+     *  &#64;Service
+     *  class X {
+     *      private Dictionary m_config;
+     *      
+     *      &#64;ConfigurationDependency(pid="MyPid")
+     *      void configure(Dictionary conf) {
+     *           // Initialize our service from config ...
+     *           
+     *           // And store the config for later usage (from our init method)
+     *           m_config = config;
+     *      }
+     * 
+     *      // The returned Map will be used to configure our "dependency1" 
Dependency.
+     *      &#64;Init
+     *      Map init() {
+     *          return new HashMap() {{
+     *              put("dependency1.filter", m_config.get("filter"));
+     *              put("dependency1.required", m_config.get("required"));
+     *          }};
+     *      } 
+     *      
+     *      &#64;ServiceDependency(name="dependency1") 
+     *      void bindOtherService(OtherService other) {
+     *         // the filter and required flag will be configured from our 
init method.
+     *      }
+     *  }
+     *  </pre></blockquote>
      */
     String name() default "";
 }

Modified: 
felix/trunk/dependencymanager/runtime/src/main/java/org/apache/felix/dm/runtime/ServiceLifecycleHandler.java
URL: 
http://svn.apache.org/viewvc/felix/trunk/dependencymanager/runtime/src/main/java/org/apache/felix/dm/runtime/ServiceLifecycleHandler.java?rev=953586&r1=953585&r2=953586&view=diff
==============================================================================
--- 
felix/trunk/dependencymanager/runtime/src/main/java/org/apache/felix/dm/runtime/ServiceLifecycleHandler.java
 (original)
+++ 
felix/trunk/dependencymanager/runtime/src/main/java/org/apache/felix/dm/runtime/ServiceLifecycleHandler.java
 Fri Jun 11 07:18:23 2010
@@ -52,24 +52,23 @@ import org.osgi.service.log.LogService;
  * 
  * Example of a Service whose dependency filter is configured from ConfigAdmin:
  * 
- * <blockquote>
- * 
- * <pre>
+ * <blockquote><pre>
  *  &#47;**
- *    * All Service whose service dependency filter/require attribute may be 
configured from ConfigAdmin
+ *    * A Service whose service dependency filter/require attribute may be 
configured from ConfigAdmin
  *    *&#47;
  *  &#64;Service
  *  class X {
  *      private Dictionary m_config;
  *      
- *      @ConfigurationDependency(pid="MyPid")
+ *      &#64;ConfigurationDependency(pid="MyPid")
  *      void configure(Dictionary conf) {
  *           // Initialize our service from config ...
  *           
- *           // And store the config for late usage (from our init method)
+ *           // And store the config for later usage (from our init method)
  *           m_config = config;
  *      }
- * 
+ *
+ *      // The returned Map will be used to configure our "dependency1" 
Dependency.
  *      &#64;Init
  *      Map init() {
  *          return new HashMap() {{
@@ -83,6 +82,7 @@ import org.osgi.service.log.LogService;
  *         // the filter and required flag will be configured from our init 
method.
  *      }
  *  }
+ *  </pre></blockquote>
  */
 public class ServiceLifecycleHandler
 {