[jboss-cvs] JBossAS SVN: r57673 - projects/microcontainer/trunk/deployers/src/main/org/jboss/deployers/plugins/deployers/helpers

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

Author: scott.stark at jboss.org
Date: 2006-10-14 19:35:36 -0400 (Sat, 14 Oct 2006)
New Revision: 57673

Modified:
   projects/microcontainer/trunk/deployers/src/main/org/jboss/deployers/plugins/deployers/helpers/ObjectModelFactoryDeployer.java
Log:
Update the javadoc

Modified: projects/microcontainer/trunk/deployers/src/main/org/jboss/deployers/plugins/deployers/helpers/ObjectModelFactoryDeployer.java
===================================================================
--- projects/microcontainer/trunk/deployers/src/main/org/jboss/deployers/plugins/deployers/helpers/ObjectModelFactoryDeployer.java	2006-10-14 06:58:26 UTC (rev 57672)
+++ projects/microcontainer/trunk/deployers/src/main/org/jboss/deployers/plugins/deployers/helpers/ObjectModelFactoryDeployer.java	2006-10-14 23:35:36 UTC (rev 57673)
@@ -31,10 +31,14 @@
 import org.jboss.xb.binding.UnmarshallerFactory;
 
 /**
- * SchemaResolverDeployer.
+ * ObjectModelFactoryDeployer extends the AbstractParsingDeployer to add an
+ * abstract JBossXB ObjectModelFactory accessor that is used from within an
+ * overriden parse(DeploymentUnit unit, VirtualFile file) to unmarshall the xml
+ * document represented by file into an instance of deploymentType T.
  * 
  * @param <T> the expected type 
  * @author <a href="adrian at jboss.com">Adrian Brock</a>
+ * @author Scott.Stark at jboss.org
  * @version $Revision: 1.1 $
  */
 public abstract class ObjectModelFactoryDeployer<T> extends AbstractParsingDeployer<T>
@@ -54,11 +58,14 @@
    }
 
    /**
-    * Parse a deployment
+    * Parse a deployment. The entails obtaining the metadata file contents via
+    * its URL handler, creating a jbossxb Unmarshaller, and unmarshalling the
+    * metdata into deployment type T via the associated ObjectModelFactory. 
     * 
     * @param unit the deployment unit
     * @param file the metadata file
-    * @param root - possibly null pre-existing root
+    * @param root - possibly null pre-existing root. It should be null if there
+    * is no pre-existing that should be passed to the ObjectModelFactory.
     * @return the metadata
     * @throws Exception for any error
     */