DPML Notify

[mcconnell AT dpml.net]

Author: mcconnell AT dpml.net
Date: Tue Mar  8 14:50:15 2005
New Revision: 1983

Modified:
   
development/laboratory/plus/part/src/main/net/dpml/composition/part/ControlMonitor.java
   
development/laboratory/plus/part/src/main/net/dpml/composition/part/Controller.java
   
development/laboratory/plus/part/src/main/net/dpml/composition/part/StartableController.java
Log:


Modified: 
development/laboratory/plus/part/src/main/net/dpml/composition/part/ControlMonitor.java
==============================================================================
--- 
development/laboratory/plus/part/src/main/net/dpml/composition/part/ControlMonitor.java
     (original)
+++ 
development/laboratory/plus/part/src/main/net/dpml/composition/part/ControlMonitor.java
     Tue Mar  8 14:50:15 2005
@@ -19,16 +19,35 @@
 package net.dpml.composition.part;
 
 /**
- * Common interface implemented by controllers.
+ * Monitor supplied to a startable controller.
  *
  * @author <a href="mailto:dev-dpml AT lists.ibiblio.org";>The Digital Product 
Meta Library</a>
  * @version $Revision: 1.2 $ $Date: 2004/03/17 10:30:09 $
  */
 public interface ControlMonitor
 {
+   /**
+    * Log the supplied info level message.
+    * @param mesage the message to log
+    */
     void info( String message );
 
+   /**
+    * Log the supplied debug level message.
+    * @param mesage the message to log
+    */
     void debug( String message );
 
-    void error( String message, Throwable cause );
+   /**
+    * Log the supplied error level message.
+    * @param mesage the message to log
+    * @param throwable the exception
+    */
+    void error( String message, Throwable throwable );
+
+   /**
+    * Log the monitor of a runtime failure.
+    * @param throwable the failure cause
+    */
+    notifyRuntimeFailure( Throwable e );
 }

Modified: 
development/laboratory/plus/part/src/main/net/dpml/composition/part/Controller.java
==============================================================================
--- 
development/laboratory/plus/part/src/main/net/dpml/composition/part/Controller.java
 (original)
+++ 
development/laboratory/plus/part/src/main/net/dpml/composition/part/Controller.java
 Tue Mar  8 14:50:15 2005
@@ -26,8 +26,16 @@
  */
 public interface Controller
 {
+   /**
+    * Return the controller urn that identifies the controller type.
+    * @return the controller type urn
+    */
     String getURN();
 
+   /**
+    * Return a human readable short name of the controller.
+    * @return the controller name
+    *
     String getName();
 
 }

Modified: 
development/laboratory/plus/part/src/main/net/dpml/composition/part/StartableController.java
==============================================================================
--- 
development/laboratory/plus/part/src/main/net/dpml/composition/part/StartableController.java
        (original)
+++ 
development/laboratory/plus/part/src/main/net/dpml/composition/part/StartableController.java
        Tue Mar  8 14:50:15 2005
@@ -19,16 +19,24 @@
 package net.dpml.composition.part;
 
 /**
- * Common interface implemented by controllers.
+ * A startable controller is a controller that may be started and stopped by 
a higher 
+ * level management system.
  *
  * @author <a href="mailto:dev-dpml AT lists.ibiblio.org";>The Digital Product 
Meta Library</a>
  * @version $Revision: 1.2 $ $Date: 2004/03/17 10:30:09 $
  */
 public interface StartableController extends Controller
 {
-
+   /**
+    * Start the controller.  
+    * @param monitor a control monitor supplied by a controlling system
+    * @exception if a startup failure occurs
+    */
     void start( ControlMonitor monitor ) throws Exception;
 
+   /**
+    * Stop the controller.  
+    */
     void stop();
 
 }