svn commit: r685839 - /myfaces/core/trunk/api/src/main/java/javax/faces/component/UIInput.java

[sk...@apache.org]

Author: skitching
Date: Thu Aug 14 03:27:41 2008
New Revision: 685839

URL: http://svn.apache.org/viewvc?rev=685839&view=rev
Log:
Minor documentation improvement

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

Modified: myfaces/core/trunk/api/src/main/java/javax/faces/component/UIInput.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/java/javax/faces/component/UIInput.java?rev=685839&r1=685838&r2=685839&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/java/javax/faces/component/UIInput.java (original)
+++ myfaces/core/trunk/api/src/main/java/javax/faces/component/UIInput.java Thu Aug 14 03:27:41 2008
@@ -100,6 +100,14 @@
         super.setValue(value);
     }
 
+    /**
+     * Return the current value of this component.
+     * <p>
+     * If a submitted value has been converted but not yet pushed into the
+     * model, then return that locally-cached value (see isLocalValueSet).
+     * <p>
+     * Otherwise, evaluate an EL expression to fetch a value from the model. 
+     */
     public Object getValue()
     {
         if (isLocalValueSet()) return super.getLocalValue();
@@ -394,9 +402,15 @@
      * <ul>
      * <li> isValid() is true
      * <li> isLocalValueSet() is true
+     * <li> getValue() will return the converted value, NOT evaluate the
+     * EL expression bound to the "value" attribute. Note that the getValue
+     * method will return to normal behaviour (evaluating its EL expression)
+     * after a successful update-model phase, ie after pushing this converted
+     * value into the model.
      * <li> submittedValue is reset to null
      * <li> a ValueChangeEvent is queued if the new value != old value
      * </ul> 
+     * 
      */
     public void validate(FacesContext context)
     {