Home » Mojarra-2.0.1 » javax » faces » component » [javadoc | source]
javax.faces.component
public interface: StateHolder [javadoc | source]

This interface is implemented by classes that need to save their state between requests.

An implementor must implement both #saveState and #restoreState methods in this class, since these two methods have a tightly coupled contract between themselves. In other words, if there is an ineritance hierarchy, it is not permissable to have the #saveState and #restoreState methods reside at different levels of the hierarchy.

An implementor must have a public no-args constructor.

Method from javax.faces.component.StateHolder Summary:
isTransient,   restoreState,   saveState,   setTransient
Method from javax.faces.component.StateHolder Detail:
 public boolean isTransient()
    If true, the Object implementing this interface must not
participate in state saving or restoring.
 public  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  method on all those
instances as well. 
 public 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  method on all those
instances as well.  This method must not save the state
of children and facets. That is done via the javax.faces.application.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
 public  void setTransient(boolean newTransientValue)
    Denotes whether or not the Object implementing this interface must
or must not participate in state saving or restoring.