public interface TransientStateHolder
This interface is implemented by classes that need to save state that is expected to be available only within the scope of the current request.
An implementor must implement both saveTransientState(jakarta.faces.context.FacesContext)
and restoreTransientState(jakarta.faces.context.FacesContext, java.lang.Object)
methods in this class, since these two methods have a tightly coupled contract between themselves. In other words, if
there is an inheritance hierarchy, it is not permissible to have the saveTransientState(jakarta.faces.context.FacesContext)
and
restoreTransientState(jakarta.faces.context.FacesContext, java.lang.Object)
methods reside at different levels of the hierarchy.
An example of transient state is the "submitted" property on forms.
Modifier and Type | Method and Description |
---|---|
void |
restoreTransientState(FacesContext context,
Object state)
Restore the "transient state" using the object passed as state. |
Object |
saveTransientState(FacesContext context)
Return the object containing related "transient states". |
Object saveTransientState(FacesContext context)
Return the object containing related "transient states". that could be used later to restore the "transient state".
context
- the Faces context.void restoreTransientState(FacesContext context, Object state)
Restore the "transient state" using the object passed as state.
If the state
argument is null
clear any previous transient state if any and return.
context
- the Faces contextstate
- the object containing transient valuesCopyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.