[jboss-cvs] JBossAS SVN: r71723 - in projects/microcontainer/trunk: kernel/src/main/org/jboss/kernel/plugins/dependency and 1 other directory.

[jboss-cvs-commits at lists.jboss.org]

Author: alesj
Date: 2008-04-04 11:11:08 -0400 (Fri, 04 Apr 2008)
New Revision: 71723

Modified:
   projects/microcontainer/trunk/dependency/src/main/org/jboss/dependency/plugins/AbstractController.java
   projects/microcontainer/trunk/kernel/src/main/org/jboss/kernel/plugins/dependency/ScopedKernelController.java
Log:
javadocs

Modified: projects/microcontainer/trunk/dependency/src/main/org/jboss/dependency/plugins/AbstractController.java
===================================================================
--- projects/microcontainer/trunk/dependency/src/main/org/jboss/dependency/plugins/AbstractController.java	2008-04-04 13:59:18 UTC (rev 71722)
+++ projects/microcontainer/trunk/dependency/src/main/org/jboss/dependency/plugins/AbstractController.java	2008-04-04 15:11:08 UTC (rev 71723)
@@ -211,6 +211,14 @@
       }
    }
 
+   /**
+    * Add controller context.
+    *
+    * This is normally used when switching from top
+    * level controller to a scoped one.
+    *
+    * @param context the controller context
+    */
    void addControllerContext(ControllerContext context)
    {
       lockWrite();
@@ -224,6 +232,14 @@
       }
    }
 
+   /**
+    * Remove controller context.
+    *
+    * This is normally used when switching from scoped
+    * level controller to a top one.
+    *
+    * @param context the controller context
+    */
    void removeControllerContext(ControllerContext context)
    {
       lockWrite();
@@ -237,16 +253,31 @@
       }
    }
 
+   /**
+    * Get the parent controller.
+    *
+    * @return the parent controller
+    */
    protected AbstractController getParentController()
    {
       return parentController;
    }
 
+   /**
+    * Set the parent controller.
+    *
+    * @param parentController the parent controller
+    */
    protected void setParentController(AbstractController parentController)
    {
       this.parentController = parentController;
    }
 
+   /**
+    * Get child controllers.
+    *
+     * @return the child controllers
+    */
    public Set<AbstractController> getControllers()
    {
       lockRead();
@@ -260,6 +291,12 @@
       }
    }
 
+   /**
+    * Add child controller.
+    *
+    * @param controller the child controller
+    * @return true if equal controller has been already added, see Set.add usage 
+    */
    public boolean addController(AbstractController controller)
    {
       lockWrite();
@@ -273,6 +310,12 @@
       }
    }
 
+   /**
+    * Remove child controller.
+    *
+    * @param controller the child controller
+    * @return true if equal controller was present, see Set.remove usage
+    */
    public boolean removeController(AbstractController controller)
    {
       lockWrite();
@@ -304,6 +347,12 @@
       }
    }
 
+   /**
+    * Get all the contexts.
+    * In state decending order.
+    *
+    * @return all contexts
+    */
    public Set<ControllerContext> getAllContexts()
    {
       lockRead();
@@ -439,6 +488,13 @@
       uninstall(alias + "_Alias");
    }
 
+   /**
+    * Uninstall the context.
+    *
+    * @param name the context name
+    * @param level the controller level
+    * @return uninstalled controller context
+    */
    // todo - some better way to find context's by name
    // currently the first one found is used
    protected ControllerContext uninstall(Object name, int level)
@@ -1234,11 +1290,25 @@
       }
    }
 
+   /**
+    * Handle install lifecycle callbacks.
+    *
+    * @param context the context
+    * @param state the state
+    * @throws Throwable for any error
+    */
    protected void handleInstallLifecycleCallbacks(ControllerContext context, ControllerState state) throws Throwable
    {
       handleLifecycleCallbacks(context, state, true);
    }
 
+   /**
+    * Handle uninstall lifecycle callbacks.
+    *
+    * @param context the context
+    * @param state the state
+    * @throws Throwable for any error
+    */
    protected void handleUninstallLifecycleCallbacks(ControllerContext context, ControllerState state) throws Throwable
    {
       int index = states.indexOf(state);
@@ -1246,6 +1316,14 @@
       handleLifecycleCallbacks(context, oldState, false);
    }
 
+   /**
+    * Handle lifecycle callbacks.
+    *
+    * @param context the context
+    * @param state the state
+    * @param install is it install or uninstall
+    * @throws Throwable for any error
+    */
    protected void handleLifecycleCallbacks(ControllerContext context, ControllerState state, boolean install) throws Throwable
    {
       DependencyInfo di = context.getDependencyInfo();

Modified: projects/microcontainer/trunk/kernel/src/main/org/jboss/kernel/plugins/dependency/ScopedKernelController.java
===================================================================
--- projects/microcontainer/trunk/kernel/src/main/org/jboss/kernel/plugins/dependency/ScopedKernelController.java	2008-04-04 13:59:18 UTC (rev 71722)
+++ projects/microcontainer/trunk/kernel/src/main/org/jboss/kernel/plugins/dependency/ScopedKernelController.java	2008-04-04 15:11:08 UTC (rev 71723)
@@ -66,11 +66,24 @@
       getParentController().addController(this);
    }
 
+   /**
+    * Is parent controller a kernel controller.
+    *
+    * @return true if parent controller in kernel controller
+    */
    private boolean isParentKernelController()
    {
       return (getParentController() instanceof KernelController);
    }
 
+   /**
+    * Get parent kernel controller.
+    *
+    * Exception is thrown if the underlying controller
+    * is not kernel controller.
+    *
+    * @return kernel controller
+    */
    private KernelController getParentKernelController()
    {
       if (isParentKernelController() == false)
@@ -90,6 +103,9 @@
       super.removeControllerContext(context);
    }
 
+   /**
+    * Perform release of resources.
+    */
    void release()
    {
       getParentController().removeController(this);
@@ -212,8 +228,6 @@
       }
    }
 
-   
-
    // KernelRegistry plugin method
 
    public KernelRegistryEntry getEntry(Object name)
@@ -270,5 +284,4 @@
          return parentKernel.getMetaDataRepository();
       }
    }
-
 }