Interface StateHolder

Method Detail

• saveState

  Object saveState(FacesContext context)

  Gets the state of the instance as a Serializable Object.

  If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the saveState(javax.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager

  This method must not alter the state of the implementing object. In other words, after executing this code:

   Object state = component.saveState(facesContext);
   

  component should be the same as before executing it.

  The return from this method must be Serializable

  Throws:

  NullPointerException - if context is null

• restoreState

  void restoreState(FacesContext context,
                    Object state)

  Perform any processing required to restore the state from the entries in the state Object.

  If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

  If the state argument is null, take no action and return.

  Throws:

  NullPointerException - if context is null.

• isTransient

  boolean isTransient()

  If true, the Object implementing this interface must not participate in state saving or restoring.

• setTransient

  void setTransient(boolean newTransientValue)

  Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

  Parameters:

  newTransientValue - boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.