[richfaces-svn-commits] JBoss Rich Faces SVN: r12474 - trunk/framework/api/src/main/java/org/ajax4jsf/component.

[richfaces-svn-commits at lists.jboss.org]

Author: nbelaevski
Date: 2009-01-28 13:42:52 -0500 (Wed, 28 Jan 2009)
New Revision: 12474

Modified:
   trunk/framework/api/src/main/java/org/ajax4jsf/component/IterationStateHolder.java
Log:
Javadoc updated for the case of null value

Modified: trunk/framework/api/src/main/java/org/ajax4jsf/component/IterationStateHolder.java
===================================================================
--- trunk/framework/api/src/main/java/org/ajax4jsf/component/IterationStateHolder.java	2009-01-28 17:46:21 UTC (rev 12473)
+++ trunk/framework/api/src/main/java/org/ajax4jsf/component/IterationStateHolder.java	2009-01-28 18:42:52 UTC (rev 12474)
@@ -38,8 +38,10 @@
 	public Object getIterationState();
 	
 	/**
-	 * Restore component state from previsious saved value.
-	 * @param state request-scope component state. Details are subject for a component implementation
+	 * Set component state for the next iteration. State can be either previously saved iteration state
+	 * or <code>null</code> value. In the second case component should reset its state to the initial.
+	 * @param state request-scope component state or <code>null</code>. Details are subject for a component 
+	 * implementation
 	 */
 	public void setIterationState( Object state);