svn commit: r356384 - /myfaces/api/trunk/src/java/javax/faces/component/UIInput.java

[sk...@apache.org]

Author: skitching
Date: Mon Dec 12 13:31:14 2005
New Revision: 356384

URL: http://svn.apache.org/viewcvs?rev=356384&view=rev
Log:
Add javadoc.

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

Modified: myfaces/api/trunk/src/java/javax/faces/component/UIInput.java
URL: http://svn.apache.org/viewcvs/myfaces/api/trunk/src/java/javax/faces/component/UIInput.java?rev=356384&r1=356383&r2=356384&view=diff
==============================================================================
--- myfaces/api/trunk/src/java/javax/faces/component/UIInput.java (original)
+++ myfaces/api/trunk/src/java/javax/faces/component/UIInput.java Mon Dec 12 13:31:14 2005
@@ -32,7 +32,9 @@
 import java.util.List;
 
 /**
- * see Javadoc of JSF Specification
+ * Base class for all components which can accept user input.
+ * <p>
+ * See Javadoc of JSF Specification
  *
  * @author Manfred Geiler (latest modification by $Author$)
  * @version $Revision$ $Date$
@@ -53,62 +55,97 @@
     private MethodBinding _valueChangeListener = null;
     private List _validatorList = null;
 
+    // use javadoc inherited from EditableValueHolder
     public Object getSubmittedValue()
     {
         return _submittedValue;
     }
 
+    // use javadoc inherited from EditableValueHolder
     public void setSubmittedValue(Object submittedValue)
     {
         _submittedValue = submittedValue;
     }
 
+    /**
+     * Store the specified object as the "local value" of this component.
+     * The value-binding named "value" (if any) is ignored; the object is
+     * only stored locally on this component. During the "update model"
+     * phase, if there is a value-binding named "value" then this local
+     * value will be stored via that value-binding and the "local value"
+     * reset to null.
+     */
     public void setValue(Object value)
     {
         setLocalValueSet(true);
         super.setValue(value);
     }
 
+    // use javadoc inherited from EditableValueHolder
     public boolean isLocalValueSet()
     {
         return _localValueSet;
     }
 
+    // use javadoc inherited from EditableValueHolder
     public void setLocalValueSet(boolean localValueSet)
     {
         _localValueSet = localValueSet;
     }
 
+    // use javadoc inherited from EditableValueHolder
     public boolean isValid()
     {
         return _valid;
     }
 
+    // use javadoc inherited from EditableValueHolder
     public void setValid(boolean valid)
     {
         _valid = valid;
     }
 
+    // use javadoc inherited from EditableValueHolder
     public MethodBinding getValidator()
     {
         return _validator;
     }
 
+    // use javadoc inherited from EditableValueHolder
     public void setValidator(MethodBinding validator)
     {
         _validator = validator;
     }
 
+    // use javadoc inherited from EditableValueHolder
     public MethodBinding getValueChangeListener()
     {
         return _valueChangeListener;
     }
 
+    // use javadoc inherited from EditableValueHolder
     public void setValueChangeListener(MethodBinding valueChangeListener)
     {
         _valueChangeListener = valueChangeListener;
     }
 
+    /**
+     * Set the "submitted value" of this component from the relevant data
+     * in the current servet request object.
+     * <p>
+     * If this component is not rendered, then do nothing; no output would
+     * have been sent to the client so no input is expected.
+     * <p>
+     * Invoke the inherited functionality, which typically invokes the
+     * renderer associated with this component to extract and set this
+     * component's "submitted value".
+     * <p>
+     * If this component is marked "immediate", then immediately apply
+     * validation to the submitted value found. On error, call context
+     * method "renderResponse" which will force processing to leap to
+     * the "render response" phase as soon as the "decode" step has
+     * completed for all other components.
+     */
     public void processDecodes(FacesContext context)
     {
         if (context == null) throw new NullPointerException("context");
@@ -263,8 +300,9 @@
      * if necessary.
      * <p>
      * The "submitted value" is converted to the necessary type; conversion
-     * failure is reported as an error and processing terminates. See
-     * documentation for method getConvertedValue for details.
+     * failure is reported as an error and validation processing terminates
+     * for this component. See documentation for method getConvertedValue
+     * for details on the conversion process.
      * <p>
      * Any validators attached to this component are then run, passing
      * the converted value.