DPML Notify

[mcconnell AT netcompartner.com]

Author: mcconnell
Date: Sun Jan  2 22:55:48 2005
New Revision: 1342

Modified:
   
development/main/metro/meta/api/src/main/net/dpml/meta/info/InfoDescriptor.java
Log:
add missing javadoc

Modified: 
development/main/metro/meta/api/src/main/net/dpml/meta/info/InfoDescriptor.java
==============================================================================
--- 
development/main/metro/meta/api/src/main/net/dpml/meta/info/InfoDescriptor.java
     (original)
+++ 
development/main/metro/meta/api/src/main/net/dpml/meta/info/InfoDescriptor.java
     Sun Jan  2 22:55:48 2005
@@ -105,6 +105,7 @@
 
     /**
      * Flag indicating if this is a native metro descriptor or avalon 
descriptor.
+     * TODO: change this to a versioned service protocol spec
      */
     private final boolean m_native;
 
@@ -119,6 +120,10 @@
      * @param name the component name
      * @param classname the implemetation classname
      * @param version the implementation version
+     * @param lifestyle the component lifestyle (singleton, per-thread, etc.)
+     * @param collection the garbage collection policy for the component
+     * @param schema the configuration schema
+     * @param flag native matro flag
      * @param attributes a set of attributes associated with the component 
type
      * @exception IllegalArgumentException if the implementation key is not 
a classname
      * @since 1.2
@@ -192,6 +197,11 @@
         }
     }
 
+   /**
+    * Check that the supplied lifestyle attribute is a valid value.
+    * @param lifestyle the lifestyle string
+    * @exception IllegalArgumentException if the value is not recognized
+    */
     private void validateLifestyle( String lifestyle ) throws 
IllegalArgumentException
     {
         if ( lifestyle.equals( TRANSIENT )
@@ -204,6 +214,12 @@
         throw new IllegalArgumentException( error );
     }
 
+   /**
+    * Internal utility to get the name of the class without the package 
name. Used 
+    * when constructing a default component name.
+    * @param classname the fully qualified classname
+    * @return the short class name without the package name
+    */
     private String getClassName( String classname )
     {
         int i = classname.lastIndexOf( "." );
@@ -330,7 +346,7 @@
     * Test is the supplied object is equal to this object.
     * @return true if the object are equivalent
     */
-    public boolean equals(Object other)
+    public boolean equals( Object other )
     {
         boolean isEqual = super.equals(other) && other instanceof 
InfoDescriptor;
 
@@ -391,6 +407,11 @@
         return hash;
     }
 
+   /**
+    * Return a string value of a collection policy.
+    * @param policy the collection policy
+    * @return the value as a string
+    */
     public static String getCollectionPolicyKey( int policy )
     {
         if ( policy == UNDEFINED )
@@ -420,6 +441,11 @@
         }
     }
 
+   /**
+    * Return the integer value of a collection policy string.
+    * @param policy the collection policy string value
+    * @return the value as a collection policy integer value
+    */
     public static int getCollectionPolicy( String policy )
     {
         if ( policy == null )