EE4J Web API 10.0.0 · jakarta.faces.application.StateManagerWrapper

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.

Field Summary

Modifier and Type	Field and Description
private StateManager	wrapped

Inherited from 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

Access	Constructor and Description
public	StateManagerWrapper(StateManager The implementation being wrapped. wrapped) If this state manager has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and Type	Method and Description
public String	getViewState(FacesContext `FacesContext` for the current request context) Overrides jakarta.faces.application.StateManager.getViewState. The default behavior of this method is to call `StateManager#getViewState(jakarta.faces.context.FacesContext)` on the wrapped `StateManager` object.
public StateManager	getWrapped() Implements jakarta.faces.FacesWrapper.getWrapped. A class that implements this interface uses this method to return an instance of the class being wrapped.
public boolean	isSavingStateInClient(FacesContext the Faces context. context) Overrides jakarta.faces.application.StateManager.isSavingStateInClient. The default behavior of this method is to call `StateManager#isSavingStateInClient(jakarta.faces.context.FacesContext)` on the wrapped `StateManager` object.
public void	writeState(FacesContext `FacesContext` for the current request context, Object the state to be written state) Overrides jakarta.faces.application.StateManager.writeState. The default behavior of this method is to call `StateManager#writeState(jakarta.faces.context.FacesContext, java.lang.Object)` on the wrapped `StateManager` object.

Field Detail

wrapped	back to summary
private StateManager wrapped

Constructor Detail

StateManagerWrapper back to summary

StateManagerWrapper	back to summary
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:StateManager The implementation being wrapped. Since 2.3

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:StateManager: The implementation being wrapped.

Since

2.3

Method Detail

getViewState back to summary

getViewState	back to summary
public String getViewState(FacesContext context) Overrides jakarta.faces.application.StateManager.getViewState. The default behavior of this method is to call `StateManager#getViewState(jakarta.faces.context.FacesContext)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from jakarta.faces.application.StateManager.getViewState. `FacesContext` for the current request Returns:String Doc from jakarta.faces.application.StateManager.getViewState. the view state. Annotations @Override Since 2.0

public String getViewState(FacesContext context)

Overrides jakarta.faces.application.StateManager.getViewState.

The default behavior of this method is to call StateManager#getViewState(jakarta.faces.context.FacesContext) on the wrapped StateManager object.

Parameters

context:FacesContext

Doc from jakarta.faces.application.StateManager.getViewState.

FacesContext for the current request

Returns:String

Doc from jakarta.faces.application.StateManager.getViewState.

the view state.

Annotations

@Override

Since

2.0

getWrapped	back to summary
public StateManager getWrapped() Implements jakarta.faces.FacesWrapper.getWrapped. Doc from jakarta.faces.FacesWrapper.getWrapped. A class that implements this interface uses this method to return an instance of the class being wrapped. Returns:StateManager the wrapped instance. Annotations @Override

getWrapped

back to summary

public StateManager getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

Doc from jakarta.faces.FacesWrapper.getWrapped.

A class that implements this interface uses this method to return an instance of the class being wrapped.

Returns:StateManager

the wrapped instance.

Annotations

@Override

isSavingStateInClient back to summary

isSavingStateInClient	back to summary
public boolean isSavingStateInClient(FacesContext context) Overrides jakarta.faces.application.StateManager.isSavingStateInClient. The default behavior of this method is to call `StateManager#isSavingStateInClient(jakarta.faces.context.FacesContext)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from jakarta.faces.application.StateManager.isSavingStateInClient. the Faces context. Returns:boolean Doc from jakarta.faces.application.StateManager.isSavingStateInClient. `true` if and only if the value of the `ServletContext` init parameter named by the value of the constant `STATE_SAVING_METHOD_PARAM_NAME` is equal (ignoring case) to the value of the constant `STATE_SAVING_METHOD_CLIENT`. `false` otherwise. Annotations @Override Since 1.2 See Also `StateManager#isSavingStateInClient(jakarta.faces.context.FacesContext)`

public boolean isSavingStateInClient(FacesContext context)

Overrides jakarta.faces.application.StateManager.isSavingStateInClient.

The default behavior of this method is to call StateManager#isSavingStateInClient(jakarta.faces.context.FacesContext) on the wrapped StateManager object.

Parameters

context:FacesContext

Doc from jakarta.faces.application.StateManager.isSavingStateInClient.

the Faces context.

Returns:boolean

Doc from jakarta.faces.application.StateManager.isSavingStateInClient.

true if and only if the value of the ServletContext init parameter named by the value of the constant STATE_SAVING_METHOD_PARAM_NAME is equal (ignoring case) to the value of the constant STATE_SAVING_METHOD_CLIENT. false otherwise.

Annotations

@Override

Since

1.2

writeState back to summary

writeState	back to summary
public void writeState(FacesContext context, Object state) throws IOException Overrides jakarta.faces.application.StateManager.writeState. The default behavior of this method is to call `StateManager#writeState(jakarta.faces.context.FacesContext, java.lang.Object)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from jakarta.faces.application.StateManager.writeState. `FacesContext` for the current request state:Object Doc from jakarta.faces.application.StateManager.writeState. the state to be written Annotations @Override Exceptions IOException: Doc from jakarta.faces.application.StateManager.writeState. when an I/O error occurs. Since 1.2 See Also `StateManager#writeState(jakarta.faces.context.FacesContext, java.lang.Object)`