[jboss-cvs] JBossAS SVN: r78033 - projects/jboss-man/trunk/managed/src/main/java/org/jboss/managed/spi/factory.

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

Author: scott.stark at jboss.org
Date: 2008-09-04 20:40:06 -0400 (Thu, 04 Sep 2008)
New Revision: 78033

Modified:
   projects/jboss-man/trunk/managed/src/main/java/org/jboss/managed/spi/factory/InstanceClassFactory.java
Log:
Update javadocs

Modified: projects/jboss-man/trunk/managed/src/main/java/org/jboss/managed/spi/factory/InstanceClassFactory.java
===================================================================
--- projects/jboss-man/trunk/managed/src/main/java/org/jboss/managed/spi/factory/InstanceClassFactory.java	2008-09-05 00:18:58 UTC (rev 78032)
+++ projects/jboss-man/trunk/managed/src/main/java/org/jboss/managed/spi/factory/InstanceClassFactory.java	2008-09-05 00:40:06 UTC (rev 78033)
@@ -29,7 +29,8 @@
 
 /**
  * A plugin for obtaining the class to scan for management object
- * related annotations.
+ * related annotations, converting property values to/from MetaValue,
+ * and determining runtime component names.
  *
  * @param <T> actual attachment type
  * @author Scott.Stark at jboss.org
@@ -52,19 +53,19 @@
     * Get the value from object.
     *
     * @param beanInfo managed object's bean info
-    * @param property managed property
-    * @param attachment attachment
-    * @return meta value
+    * @param property managed property being set
+    * @param attachment - the object which own's the property
+    * @return value - the meta value form of the property value
     */
    MetaValue getValue(BeanInfo beanInfo, ManagedProperty property, T attachment);
 
    /**
-    * Set the value to object.
+    * Set the property value to attachment object.
     *
     * @param beanInfo managed object's bean info
-    * @param property managed property
-    * @param attachment attachment
-    * @param value meta value
+    * @param property managed property being set
+    * @param attachment - the object which own's the property
+    * @param value - the meta value form of the property value
     */
    void setValue(BeanInfo beanInfo, ManagedProperty property, T attachment, MetaValue value);
 
@@ -72,10 +73,11 @@
     * Get the runtime component name.
     *
     * @param beanInfo managed object's bean info
-    * @param property managed property
-    * @param attachment attachment
-    * @param value original value
-    * @return meta value
+    * @param property managed property being set
+    * @param attachment - the object which own's the property
+    * @param value - the meta value form of the property value
+    * @return the name of the runtime object which is associated with the property. May
+    * be null if no such component exists.
     */
    Object getComponentName(BeanInfo beanInfo, ManagedProperty property, T attachment, MetaValue value);
 }