svn commit: r367454 - /myfaces/api/trunk/api/src/main/java/javax/faces/component/UISelectOne.java

[sk...@apache.org]

Author: skitching
Date: Mon Jan  9 17:23:31 2006
New Revision: 367454

URL: http://svn.apache.org/viewcvs?rev=367454&view=rev
Log:
Added javadoc only.

Modified:
    myfaces/api/trunk/api/src/main/java/javax/faces/component/UISelectOne.java

Modified: myfaces/api/trunk/api/src/main/java/javax/faces/component/UISelectOne.java
URL: http://svn.apache.org/viewcvs/myfaces/api/trunk/api/src/main/java/javax/faces/component/UISelectOne.java?rev=367454&r1=367453&r2=367454&view=diff
==============================================================================
--- myfaces/api/trunk/api/src/main/java/javax/faces/component/UISelectOne.java (original)
+++ myfaces/api/trunk/api/src/main/java/javax/faces/component/UISelectOne.java Mon Jan  9 17:23:31 2006
@@ -19,6 +19,12 @@
 import javax.faces.context.FacesContext;
 
 /**
+ * Component for choosing one option out of a set of possibilities.
+ * <p>
+ * This component is expected to have children of type UISelectItem or
+ * UISelectItems; these define the set of possible options that the
+ * user can choose from.
+ * <p>
  * see Javadoc of <a href="http://java.sun.com/j2ee/javaserverfaces/1.1_01/docs/api/index.html">JSF Specification</a>
  *
  * @author Manfred Geiler (latest modification by $Author$)
@@ -29,6 +35,10 @@
     public static final String INVALID_MESSAGE_ID = "javax.faces.component.UISelectOne.INVALID";
 
     /**
+     * Verify that the result of converting the newly submitted value is
+     * <i>equal</i> to the value property of one of the child SelectItem
+     * objects. If this is not true, a validation error is reported.
+     * 
      * @see javax.faces.component.UIInput#validateValue(javax.faces.context.FacesContext, java.lang.Object)
      */
     protected void validateValue(FacesContext context, Object value)