svn commit: r534521 - in /incubator/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager: Service.java ServiceStateListener.java

[ma...@apache.org]

Author: marrs
Date: Wed May  2 08:54:56 2007
New Revision: 534521

URL: http://svn.apache.org/viewvc?view=rev&rev=534521
Log:
Updated JavaDoc documentation, because it was out of sync with the code (which is a nice way of saying it was plain wrong).

Modified:
    incubator/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/Service.java
    incubator/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceStateListener.java

Modified: incubator/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/Service.java
URL: http://svn.apache.org/viewvc/incubator/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/Service.java?view=diff&rev=534521&r1=534520&r2=534521
==============================================================================
--- incubator/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/Service.java (original)
+++ incubator/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/Service.java Wed May  2 08:54:56 2007
@@ -72,22 +72,25 @@
      * There are four special methods that are called when found through
      * reflection to give you some life-cycle management options:
      * <ol>
-     * <li><code>init()</code> when the implementation should be initialized,
-     * before it is actually registered as a service (if at all)</li>
-     * <li><code>start()</code> when the implementation has been registered
-     * as a service (if at all)</li>
-     * <li><code>stop()</code> when the implementation will be stopped, just
-     * before the service will go away (if it had been registered)</li>
-     * <li><code>destroy()</code>after the service has gone away (if it had
-     * been registered)</li>
+     * <li><code>init()</code> is invoked right after the instance has been
+     * created, and before any dependencies are resolved, and can be used to
+     * initialize the internal state of the instance</li>
+     * <li><code>start()</code> is invoked after the required dependencies
+     * are resolved and injected, and before the service is registered</li>
+     * <li><code>stop()</code> is invoked right after the service is
+     * unregistered</li>
+     * <li><code>destroy()</code> is invoked after all dependencies are
+     * removed</li>
      * </ol>
      * In short, this allows you to initialize your instance before it is
      * registered, perform some post-initialization and pre-destruction code
      * as well as final cleanup. If a method is not defined, it simply is not
-     * called, so you can decide which one(s) you need.
+     * called, so you can decide which one(s) you need. If you need even more
+     * fine-grained control, you can register as a service state listener too.
      * 
      * @param implementation the implementation
      * @return this service
+     * @see ServiceStateListener
      */
     public Service setImplementation(Object implementation);
     

Modified: incubator/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceStateListener.java
URL: http://svn.apache.org/viewvc/incubator/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceStateListener.java?view=diff&rev=534521&r1=534520&r2=534521
==============================================================================
--- incubator/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceStateListener.java (original)
+++ incubator/felix/trunk/dependencymanager/src/main/java/org/apache/felix/dependencymanager/ServiceStateListener.java Wed May  2 08:54:56 2007
@@ -26,25 +26,30 @@
  */
 public interface ServiceStateListener {
     /**
-     * Called when the service is starting.
+     * Called when the service is starting. At this point, the required
+     * dependencies have been injected, but the service has not been registered
+     * yet.
      * 
      * @param service the service
      */
     public void starting(Service service);
     /**
-     * Called when the service is started.
+     * Called when the service is started. At this point, the service has been
+     * registered.
      * 
      * @param service the service
      */
     public void started(Service service);
     /**
-     * Called when the service is stopping.
+     * Called when the service is stopping. At this point, the service is still
+     * registered.
      * 
      * @param service the service
      */
     public void stopping(Service service);
     /**
-     * Called when the service is stopped.
+     * Called when the service is stopped. At this point, the service has been
+     * unregistered.
      * 
      * @param service the service
      */