StateManagerWrapper

java.lang.Object
- jakarta.faces.application.StateManager
- - jakarta.faces.application.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 and 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.Object`	`getComponentStateToSave(FacesContext context)` The default behavior of this method is to call `StateManager.getComponentStateToSave(jakarta.faces.context.FacesContext)` on the wrapped `StateManager` object.
`protected java.lang.Object`	`getTreeStructureToSave(FacesContext context)` The default behavior of this method is to call `StateManager.getTreeStructureToSave(jakarta.faces.context.FacesContext)` on the wrapped `StateManager` object.
`java.lang.String`	`getViewState(FacesContext context)` The default behavior of this method is to call `StateManager.getViewState(jakarta.faces.context.FacesContext)` on the wrapped `StateManager` object.
`StateManager`	`getWrapped()` A class that implements this interface uses this method to return an instance of the class being wrapped.
`boolean`	`isSavingStateInClient(FacesContext context)` The default behavior of this method is to call `StateManager.isSavingStateInClient(jakarta.faces.context.FacesContext)` on the wrapped `StateManager` object.
`protected void`	`restoreComponentState(FacesContext context, UIViewRoot viewRoot, java.lang.String renderKitId)` The default behavior of this method is to call `StateManager.restoreComponentState(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot, String)` on the wrapped `StateManager` object.
`protected UIViewRoot`	`restoreTreeStructure(FacesContext context, java.lang.String viewId, java.lang.String renderKitId)` The default behavior of this method is to call `StateManager.restoreTreeStructure(jakarta.faces.context.FacesContext, String, String)` on the wrapped `StateManager` object.
`UIViewRoot`	`restoreView(FacesContext context, java.lang.String viewId, java.lang.String renderKitId)` The default behavior of this method is to call `StateManager.restoreView(jakarta.faces.context.FacesContext, String, String)` on the wrapped `StateManager` object.
`StateManager.SerializedView`	`saveSerializedView(FacesContext context)` The default behavior of this method is to call `StateManager.saveSerializedView(jakarta.faces.context.FacesContext)` on the wrapped `StateManager` object.
`java.lang.Object`	`saveView(FacesContext context)` The default behavior of this method is to call `StateManager.saveView(jakarta.faces.context.FacesContext)` on the wrapped `StateManager` object.
`void`	`writeState(FacesContext context, java.lang.Object state)` The default behavior of this method is to call `StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)` on the wrapped `StateManager` object.
`void`	`writeState(FacesContext context, StateManager.SerializedView state)` The default behavior of this method is to call `StateManager.writeState(jakarta.faces.context.FacesContext, jakarta.faces.application.StateManager.SerializedView)` on the wrapped `StateManager` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - StateManagerWrapper
```
@Deprecated
public StateManagerWrapper()
```
    Deprecated. Use the other constructor taking the implementation being wrapped.
  - StateManagerWrapper
```
public StateManagerWrapper(StateManager wrapped)
```
    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 Detail
  - getWrapped
```
public StateManager 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 interface FacesWrapper<StateManager>
    
    Returns:
    
    the wrapped instance.
  - saveSerializedView
```
public StateManager.SerializedView saveSerializedView(FacesContext context)
```
    The default behavior of this method is to call StateManager.saveSerializedView(jakarta.faces.context.FacesContext) on the wrapped StateManager object.
    
    Overrides:
    
    saveSerializedView in class StateManager
    
    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
```
public java.lang.Object saveView(FacesContext context)
```
    The default behavior of this method is to call StateManager.saveView(jakarta.faces.context.FacesContext) on the wrapped StateManager object.
    
    Overrides:
    
    saveView in class StateManager
    
    Parameters:
    
    context - FacesContext for the current request
    
    Returns:
    
    the saved view.
    
    Since:
    
    1.2
    
    See Also:
    
    StateManager.saveView(jakarta.faces.context.FacesContext)
  - getTreeStructureToSave
```
protected java.lang.Object getTreeStructureToSave(FacesContext context)
```
    The default behavior of this method is to call StateManager.getTreeStructureToSave(jakarta.faces.context.FacesContext) on the wrapped StateManager object.
    
    Overrides:
    
    getTreeStructureToSave in class StateManager
    
    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
```
protected java.lang.Object getComponentStateToSave(FacesContext context)
```
    The default behavior of this method is to call StateManager.getComponentStateToSave(jakarta.faces.context.FacesContext) on the wrapped StateManager object.
    
    Overrides:
    
    getComponentStateToSave in class StateManager
    
    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
```
public void writeState(FacesContext context,
                       java.lang.Object state)
                throws java.io.IOException
```
    The default behavior of this method is to call StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object) on the wrapped StateManager object.
    
    Overrides:
    
    writeState in class StateManager
    
    Parameters:
    
    context - FacesContext for the current request
    
    state - the Serializable state to be written, as returned by StateManager.saveSerializedView(jakarta.faces.context.FacesContext)
    
    Throws:
    
    java.io.IOException - when an I/O error occurs.
    
    Since:
    
    1.2
    
    See Also:
    
    StateManager.writeState(jakarta.faces.context.FacesContext, java.lang.Object)
  - writeState
```
public void writeState(FacesContext context,
                       StateManager.SerializedView state)
                throws java.io.IOException
```
    The default behavior of this method is to call StateManager.writeState(jakarta.faces.context.FacesContext, jakarta.faces.application.StateManager.SerializedView) on the wrapped StateManager object.
    
    Overrides:
    
    writeState in class StateManager
    
    Parameters:
    
    context - FacesContext for the current request
    
    state - the serialized state to be written
    
    Throws:
    
    java.io.IOException - when an I/O error occurs.
    
    Since:
    
    1.2
    
    See Also:
    
    StateManager.writeState(jakarta.faces.context.FacesContext, jakarta.faces.application.StateManager.SerializedView)
  - restoreView
```
public UIViewRoot restoreView(FacesContext context,
                              java.lang.String viewId,
                              java.lang.String renderKitId)
```
    The default behavior of this method is to call StateManager.restoreView(jakarta.faces.context.FacesContext, String, String) on the wrapped StateManager object.
    
    Specified by:
    
    restoreView in class StateManager
    
    Parameters:
    
    context - FacesContext for the current request
    
    viewId - View identifier of the view to be restored
    
    renderKitId - the renderKitId used to render this response. Must not be null.
    
    Returns:
    
    the view root, or null.
    
    Since:
    
    1.2
    
    See Also:
    
    StateManager.restoreView(jakarta.faces.context.FacesContext, String, String)
  - restoreTreeStructure
```
protected UIViewRoot restoreTreeStructure(FacesContext context,
                                          java.lang.String viewId,
                                          java.lang.String renderKitId)
```
    The default behavior of this method is to call StateManager.restoreTreeStructure(jakarta.faces.context.FacesContext, String, String) on the wrapped StateManager object.
    
    Overrides:
    
    restoreTreeStructure in class StateManager
    
    Parameters:
    
    context - FacesContext for the current request
    
    viewId - View identifier of the view to be restored
    
    renderKitId - the renderKitId used to render this response. Must not be null.
    
    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,
                                     java.lang.String renderKitId)
```
    The default behavior of this method is to call StateManager.restoreComponentState(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot, String) on the wrapped StateManager object.
    
    Overrides:
    
    restoreComponentState in class StateManager
    
    Parameters:
    
    context - FacesContext for the current request
    
    viewRoot - UIViewRoot returned by a previous call to restoreTreeStructure()
    
    renderKitId - the renderKitId used to render this response. Must not be null.
    
    Since:
    
    1.2
    
    See Also:
    
    StateManager.restoreComponentState(jakarta.faces.context.FacesContext, jakarta.faces.component.UIViewRoot, String)
  - isSavingStateInClient
```
public boolean isSavingStateInClient(FacesContext context)
```
    The default behavior of this method is to call StateManager.isSavingStateInClient(jakarta.faces.context.FacesContext) on the wrapped StateManager object.
    
    Overrides:
    
    isSavingStateInClient in class StateManager
    
    Parameters:
    
    context - the Faces context.
    
    Returns:
    
    true if and only if the value of the ServletContext init parameter named by the value of the constant StateManager.STATE_SAVING_METHOD_PARAM_NAME is equal (ignoring case) to the value of the constant StateManager.STATE_SAVING_METHOD_CLIENT. false otherwise.
    
    Since:
    
    1.2
    
    See Also:
    
    StateManager.isSavingStateInClient(jakarta.faces.context.FacesContext)
  - getViewState
```
public java.lang.String getViewState(FacesContext context)
```
    The default behavior of this method is to call StateManager.getViewState(jakarta.faces.context.FacesContext) on the wrapped StateManager object.
    
    Overrides:
    
    getViewState in class StateManager
    
    Parameters:
    
    context - FacesContext for the current request
    
    Returns:
    
    the view state.
    
    Since:
    
    2.0

Class StateManagerWrapper

Nested Class Summary

Nested classes/interfaces inherited from class jakarta.faces.application.StateManager

Field Summary

Fields inherited from class jakarta.faces.application.StateManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StateManagerWrapper

StateManagerWrapper

Method Detail

getWrapped

saveSerializedView

saveView

getTreeStructureToSave

getComponentStateToSave

writeState

writeState

restoreView

restoreTreeStructure

restoreComponentState

isSavingStateInClient

getViewState