cvs commit: spice/sandbox/metaclass/src/java/org/realityforge/metaclass/io DOMMetaClassDeserializer.java

donaldp     03/10/31 16:03:08

  Modified:    sandbox/metaclass/src/java/org/realityforge/metaclass/io
                        DOMMetaClassDeserializer.java
  Log:
  Add some javadocs
  
  Revision  Changes    Path
  1.9       +73 -1     spice/sandbox/metaclass/src/java/org/realityforge/metaclass/io/DOMMetaClassDeserializer.java
  
  Index: DOMMetaClassDeserializer.java
  ===================================================================
  RCS file: /cvsroot/spice/spice/sandbox/metaclass/src/java/org/realityforge/metaclass/io/DOMMetaClassDeserializer.java,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- DOMMetaClassDeserializer.java	31 Oct 2003 23:58:43 -0000	1.8
  +++ DOMMetaClassDeserializer.java	1 Nov 2003 00:03:08 -0000	1.9
  @@ -20,12 +20,21 @@
   import org.w3c.dom.Attr;
   
   /**
  + * Utility class to build a ClassDescriptor from a DOM
  + * representation Element.
    *
    * @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
  - * @version $Revision: 1.8 $ $Date: 2003/10/31 23:58:43 $
  + * @version $Revision: 1.9 $ $Date: 2003/11/01 00:03:08 $
    */
   public class DOMMetaClassDeserializer
   {
  +    /**
  +     * Build a ClassDescriptor from element.
  +     *
  +     * @param element the element
  +     * @return the ClassDescriptor
  +     * @throws Exception if element malformed
  +     */
       public ClassDescriptor buildClassDescriptor( final Element element )
           throws Exception
       {
  @@ -66,6 +75,13 @@
                                       methods );
       }
   
  +    /**
  +     * Build a set of methods from element.
  +     *
  +     * @param element the element
  +     * @return the methods
  +     * @throws Exception if element malformed
  +     */
       MethodDescriptor[] buildMethods( final Element element )
           throws Exception
       {
  @@ -89,6 +105,13 @@
               toArray( new MethodDescriptor[ methods.size() ] );
       }
   
  +    /**
  +     * Build a method from element.
  +     *
  +     * @param element the element
  +     * @return the method
  +     * @throws Exception if element malformed
  +     */
       MethodDescriptor buildMethod( final Element element )
           throws Exception
       {
  @@ -122,6 +145,13 @@
           return new MethodDescriptor( name, type, parameters, attributes, attributes );
       }
   
  +    /**
  +     * Build a set of method parameters from element.
  +     *
  +     * @param element the element
  +     * @return the method parameters
  +     * @throws Exception if element malformed
  +     */
       ParameterDescriptor[] buildParameters( Element element )
           throws Exception
       {
  @@ -146,6 +176,13 @@
               toArray( new ParameterDescriptor[ parameters.size() ] );
       }
   
  +    /**
  +     * Build a method parameter from element.
  +     *
  +     * @param element the element
  +     * @return the method parameter
  +     * @throws Exception if element malformed
  +     */
       ParameterDescriptor buildParameter( final Element element )
           throws Exception
       {
  @@ -158,6 +195,13 @@
           return new ParameterDescriptor( name, type );
       }
   
  +    /**
  +     * Build a set of fields from element.
  +     *
  +     * @param element the element
  +     * @return the fields
  +     * @throws Exception if element malformed
  +     */
       FieldDescriptor[] buildFields( final Element element )
           throws Exception
       {
  @@ -181,6 +225,13 @@
               toArray( new FieldDescriptor[ fields.size() ] );
       }
   
  +    /**
  +     * Build a field from element.
  +     *
  +     * @param element the element
  +     * @return the field
  +     * @throws Exception if element malformed
  +     */
       FieldDescriptor buildField( final Element element )
           throws Exception
       {
  @@ -204,6 +255,13 @@
           return new FieldDescriptor( name, type, attributes, attributes );
       }
   
  +    /**
  +     * Build a set of attributes from element.
  +     *
  +     * @param element the element
  +     * @return the attributes
  +     * @throws Exception if element malformed
  +     */
       Attribute[] buildAttributes( final Element element )
           throws Exception
       {
  @@ -227,6 +285,13 @@
               toArray( new Attribute[ attributes.size() ] );
       }
   
  +    /**
  +     * Build attribute from specified element.
  +     *
  +     * @param element the element
  +     * @return the attribute
  +     * @throws Exception if element malformed
  +     */
       Attribute buildAttribute( final Element element )
           throws Exception
       {
  @@ -274,6 +339,13 @@
           }
       }
   
  +    /**
  +     * Build a parameter from element and add to specified parameters.
  +     *
  +     * @param element the element
  +     * @param parameters the parameters
  +     * @throws Exception if element malformed
  +     */
       void buildParam( final Element element,
                        final Properties parameters )
           throws Exception
  
  
  


-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive?  Does it
help you create better code?   SHARE THE LOVE, and help us help
YOU!  Click Here: http://sourceforge.net/donate/