[jboss-cvs] JBossAS SVN: r104484 - projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl.

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

Author: kabir.khan at jboss.com
Date: 2010-05-05 11:48:16 -0400 (Wed, 05 May 2010)
New Revision: 104484

Modified:
   projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/BootstrapParentUnitFinder.java
   projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/JBossClClassPoolConfig.java
   projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/ParentUnitLoaderFinder.java
   projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/ParentUnitLoaderFinders.java
Log:
Better javadoc

Modified: projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/BootstrapParentUnitFinder.java
===================================================================
--- projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/BootstrapParentUnitFinder.java	2010-05-05 15:40:23 UTC (rev 104483)
+++ projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/BootstrapParentUnitFinder.java	2010-05-05 15:48:16 UTC (rev 104484)
@@ -27,6 +27,8 @@
 import org.jboss.classloading.spi.dependency.Module;
 
 /**
+ * Deployments in the bootstrap do not have a parent deployment unit so 
+ * just return null.
  * 
  * @author <a href="kabir.khan at jboss.com">Kabir Khan</a>
  * @version $Revision: 1.1 $

Modified: projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/JBossClClassPoolConfig.java
===================================================================
--- projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/JBossClClassPoolConfig.java	2010-05-05 15:40:23 UTC (rev 104483)
+++ projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/JBossClClassPoolConfig.java	2010-05-05 15:48:16 UTC (rev 104484)
@@ -56,6 +56,11 @@
       classPoolRepository.setClassPoolFactory(classPoolFactory);
    }
    
+   /**
+    * Get the singleton instance
+    * 
+    * @return the singleton instance
+    */
    public static JBossClClassPoolConfig getInstance()
    {
       if (config == null)
@@ -79,14 +84,17 @@
    
    /**
     * Get the domainRegistry
+    * 
     * @return the domainRegistry
     */
    public DomainRegistry getDomainRegistry()
    {
       return domainRegistry;
    }
+   
    /**
     * Get the classLoading
+    * 
     * @return the classLoading
     */
    public ClassLoading getClassLoading()
@@ -96,7 +104,7 @@
 
    /**
     * Set the classLoading. This should be set via a property 
-    * by the MC
+    * by the MC once the ClassLoading bean has been installed
     * 
     * @param cl the classLoading to set
     */
@@ -112,6 +120,7 @@
 
    /**
     * Get the registerModuleCallback
+    * 
     * @return the registerModuleCallback
     */
    public RegisterModuleCallback getRegisterModuleCallback()
@@ -121,6 +130,7 @@
 
    /**
     * Get the classPoolFactory
+    * 
     * @return the classPoolFactory
     */
    public ScopedClassPoolFactory getClassPoolFactory()
@@ -130,6 +140,7 @@
 
    /**
     * Set the classPoolFactory
+    * 
     * @param classPoolFactory the classPoolFactory to set
     */
    public void setClassPoolFactory(JBossClDelegatingClassPoolFactory classPoolFactory)

Modified: projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/ParentUnitLoaderFinder.java
===================================================================
--- projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/ParentUnitLoaderFinder.java	2010-05-05 15:40:23 UTC (rev 104483)
+++ projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/ParentUnitLoaderFinder.java	2010-05-05 15:48:16 UTC (rev 104484)
@@ -24,14 +24,27 @@
 import org.jboss.classloading.spi.dependency.Module;
 
 /**
- * Ab
+ * Interface to find the parent deployment unit loader for a Module.
  * 
+ * @see ParentUnitLoaderFinders
  * @author <a href="kabir.khan at jboss.com">Kabir Khan</a>
  * @version $Revision: 1.1 $
  */
 public interface ParentUnitLoaderFinder
 {
+   /**
+    * Check if we can we handle a module of the given type
+    * 
+    * @param module the module we are checking
+    * @return true if we can handle it
+    */
    boolean handle(Module module);
    
+   /**
+    * Find the parent unit loader
+    * 
+    * @param module the module we are checking
+    * @return the classloader to use as the parent
+    */
    ClassLoader findParentUnitLoader(Module module);
 }

Modified: projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/ParentUnitLoaderFinders.java
===================================================================
--- projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/ParentUnitLoaderFinders.java	2010-05-05 15:40:23 UTC (rev 104483)
+++ projects/jboss-classpool/trunk/jbosscl/src/main/java/org/jboss/classpool/plugins/jbosscl/ParentUnitLoaderFinders.java	2010-05-05 15:48:16 UTC (rev 104484)
@@ -23,6 +23,7 @@
 
 import org.jboss.classloading.spi.dependency.ClassLoading;
 import org.jboss.classloading.spi.dependency.Module;
+import org.jboss.deployers.plugins.classloading.AbstractDeploymentClassLoaderPolicyModule;
 
 /**
  * Entry point to determining the parent classloader.
@@ -40,11 +41,21 @@
    
    private volatile ParentUnitLoaderFinder abstractDeploymentClassLoaderPolicyModuleParentUnitLoaderFinder;
    
+   /**
+    * Get the singleton instance
+    * 
+    * @return the singleton
+    */
    static ParentUnitLoaderFinders getInstance()
    {
       return INSTANCE;
    }
    
+   /**
+    * Calls the registered parent unit loader finders.
+    * {@link BootstrapParentUnitFinder} is always available. Once {@link AbstractDeploymentClassLoaderPolicyModule}
+    * has been deployed its ParentUnitLoaderFinder is checked if it is of the correct type.
+    */
    ClassLoader findParentUnitLoader(Module module)
    {
       if (module == null)