Class StateManagerWrapper
- All Implemented Interfaces:
FacesWrapper<StateManager>
public abstract class StateManagerWrapper extends StateManager implements FacesWrapper<StateManager>
Provides a simple implementation of StateManager
that can be
subclassed by developers wishing to provide specialized behavior to an existing StateManager
instance. The
default implementation of all methods is to call through to the wrapped StateManager
.
Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped()
to
access the instance being wrapped.
- Since:
- 1.2
-
Nested Class Summary
Nested classes/interfaces inherited from class jakarta.faces.application.StateManager
StateManager.SerializedView
-
Field Summary
Fields inherited from class jakarta.faces.application.StateManager
FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME, IS_BUILDING_INITIAL_STATE, IS_SAVING_STATE, PARTIAL_STATE_SAVING_PARAM_NAME, SERIALIZE_SERVER_STATE_PARAM_NAME, STATE_SAVING_METHOD_CLIENT, STATE_SAVING_METHOD_PARAM_NAME, STATE_SAVING_METHOD_SERVER
-
Constructor Summary
Constructors Constructor Description StateManagerWrapper()
Deprecated.Use the other constructor taking the implementation being wrapped.StateManagerWrapper(StateManager wrapped)
If this state manager has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. -
Method Summary
-
Constructor Details
-
StateManagerWrapper
Deprecated.Use the other constructor taking the implementation being wrapped. -
StateManagerWrapper
If this state manager has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The
getWrapped()
will then return the implementation being wrapped.- Parameters:
wrapped
- The implementation being wrapped.- Since:
- 2.3
-
-
Method Details
-
getWrapped
Description copied from interface:FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
- Specified by:
getWrapped
in interfaceFacesWrapper<StateManager>
- Returns:
- the wrapped instance.
-
saveSerializedView
The default behavior of this method is to call
StateManager.saveSerializedView(jakarta.faces.context.FacesContext)
on the wrappedStateManager
object.- Overrides:
saveSerializedView
in classStateManager
- Parameters:
context
-FacesContext
for the current request- Returns:
- the serialized view, or null.
- Since:
- 1.2
- See Also:
StateManager.saveSerializedView(jakarta.faces.context.FacesContext)
-
saveView
The default behavior of this method is to call
StateManager.saveView(jakarta.faces.context.FacesContext)
on the wrappedStateManager
object.- Overrides:
saveView
in classStateManager
- Parameters:
context
-FacesContext
for the current request- Returns:
- the saved view.
- Since:
- 1.2
- See Also:
StateManager.saveView(jakarta.faces.context.FacesContext)
-
getTreeStructureToSave
The default behavior of this method is to call
StateManager.getTreeStructureToSave(jakarta.faces.context.FacesContext)
on the wrappedStateManager
object.- Overrides:
getTreeStructureToSave
in classStateManager
- Parameters:
context
-FacesContext
for the current request- Returns:
- the tree structure, or null.
- Since:
- 1.2
- See Also:
StateManager.getTreeStructureToSave(jakarta.faces.context.FacesContext)
-
getComponentStateToSave
The default behavior of this method is to call
StateManager.getComponentStateToSave(jakarta.faces.context.FacesContext)
on the wrappedStateManager
object.- Overrides:
getComponentStateToSave
in classStateManager
- Parameters:
context
-FacesContext
for the current request- Returns:
- the component state, or null.
- Since:
- 1.2
- See Also:
StateManager.getComponentStateToSave(jakarta.faces.context.FacesContext)
-
writeState
The default behavior of this method is to call
StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)
on the wrappedStateManager
object.- Overrides:
writeState
in classStateManager
- Parameters:
context
-FacesContext
for the current requeststate
- the Serializable state to be written, as returned byStateManager.saveSerializedView(jakarta.faces.context.FacesContext)
- Throws:
IOException
- when an I/O error occurs.- Since:
- 1.2
- See Also:
StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)
-
writeState
The default behavior of this method is to call
StateManager.writeState(jakarta.faces.context.FacesContext, jakarta.faces.application.StateManager.SerializedView)
on the wrappedStateManager
object.- Overrides:
writeState
in classStateManager
- Parameters:
context
-FacesContext
for the current requeststate
- the serialized state to be written- Throws:
IOException
- when an I/O error occurs.- Since:
- 1.2
- See Also:
StateManager.writeState(jakarta.faces.context.FacesContext, jakarta.faces.application.StateManager.SerializedView)
-
restoreView
The default behavior of this method is to call
StateManager.restoreView(jakarta.faces.context.FacesContext, String, String)
on the wrappedStateManager
object.- Specified by:
restoreView
in classStateManager
- Parameters:
context
-FacesContext
for the current requestviewId
- View identifier of the view to be restoredrenderKitId
- the renderKitId used to render this response. Must not benull
.- Returns:
- the view root, or
null
. - Since:
- 1.2
- See Also:
StateManager.restoreView(jakarta.faces.context.FacesContext, String, String)
-
restoreTreeStructure
The default behavior of this method is to call
StateManager.restoreTreeStructure(jakarta.faces.context.FacesContext, String, String)
on the wrappedStateManager
object.- Overrides:
restoreTreeStructure
in classStateManager
- Parameters:
context
-FacesContext
for the current requestviewId
- View identifier of the view to be restoredrenderKitId
- the renderKitId used to render this response. Must not benull
.- Returns:
- the view root, or
null
. - Since:
- 1.2
- See Also:
StateManager.restoreTreeStructure(jakarta.faces.context.FacesContext, String, String)
-
restoreComponentState
protected void restoreComponentState(FacesContext context, UIViewRoot viewRoot, String renderKitId)The default behavior of this method is to call
StateManager.restoreComponentState(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot, String)
on the wrappedStateManager
object.- Overrides:
restoreComponentState
in classStateManager
- Parameters:
context
-FacesContext
for the current requestviewRoot
-UIViewRoot
returned by a previous call torestoreTreeStructure()
renderKitId
- the renderKitId used to render this response. Must not benull
.- Since:
- 1.2
- See Also:
StateManager.restoreComponentState(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot, String)
-
isSavingStateInClient
The default behavior of this method is to call
StateManager.isSavingStateInClient(jakarta.faces.context.FacesContext)
on the wrappedStateManager
object.- Overrides:
isSavingStateInClient
in classStateManager
- Parameters:
context
- the Faces context.- Returns:
true
if and only if the value of theServletContext
init parameter named by the value of the constantStateManager.STATE_SAVING_METHOD_PARAM_NAME
is equal (ignoring case) to the value of the constantStateManager.STATE_SAVING_METHOD_CLIENT
.false
otherwise.- Since:
- 1.2
- See Also:
StateManager.isSavingStateInClient(jakarta.faces.context.FacesContext)
-
getViewState
The default behavior of this method is to call
StateManager.getViewState(jakarta.faces.context.FacesContext)
on the wrappedStateManager
object.- Overrides:
getViewState
in classStateManager
- Parameters:
context
-FacesContext
for the current request- Returns:
- the view state.
- Since:
- 2.0
-