Commits

hani  committed 6484f4b
  • Participants
  • Parent commits d275082

Comments (0)

Files changed (1)

File src/java/com/opensymphony/module/propertyset/PropertySetManager.java

 
 
 /**
- * DOCUMENT ME!
+ * The PropertySetManager is a factory for all the different types of
+ * propertysets registered.
  *
  * @author $author$
  * @version $Revision$
 public class PropertySetManager {
     //~ Methods ////////////////////////////////////////////////////////////////
 
+    /**
+     * Get a propertyset by name.
+     * @param name The name of the propertyset as registered in propertyset.xml.
+     * For example 'ejb', or 'memory'.
+     * @param args The arguments to pass to the propertyset for initialization.
+     * Consult the javadocs for a particular propertyset to see what arguments
+     * it requires and supports.
+     */
     public static PropertySet getInstance(String name, Map args) {
         PropertySet ps = getInstance(name, args, PropertySetManager.class.getClassLoader());
 
         return ps;
     }
 
+    /**
+     * @see #getInstance(String, java.util.Map)
+     * @param loader The classloader to use for loading the propertyset.
+     */
     public static PropertySet getInstance(String name, Map args, ClassLoader loader) {
         PropertySetConfig psc = PropertySetConfig.getConfig();
         String clazz = psc.getClassName(name);
         return null;
     }
 
+    /**
+     * Copy the contents of one propertyset into another.
+     * @param src The propertyset to copy from.
+     * @param dest The propertyset to copy into.
+     */
     public static void clone(PropertySet src, PropertySet dest) {
         PropertySetCloner cloner = new PropertySetCloner();
         cloner.setSource(src);