Mojarra 2.4.0 · javax.faces.application.StateManagerWrapper

Modifier and Type	Field and Description
private StateManager	wrapped

Access	Constructor and Description
public	StateManagerWrapper() Deprecated Use the other constructor taking the implementation being wrapped.
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.

Modifier and Type	Method and Description
protected Object	getComponentStateToSave(FacesContext `FacesContext` for the current request context) Overrides javax.faces.application.StateManager.getComponentStateToSave. The default behavior of this method is to call `StateManager#getComponentStateToSave(javax.faces.context.FacesContext)` on the wrapped `StateManager` object.
protected Object	getTreeStructureToSave(FacesContext `FacesContext` for the current request context) Overrides javax.faces.application.StateManager.getTreeStructureToSave. The default behavior of this method is to call `StateManager#getTreeStructureToSave(javax.faces.context.FacesContext)` on the wrapped `StateManager` object.
public String	getViewState(FacesContext `FacesContext` for the current request context) Overrides javax.faces.application.StateManager.getViewState. The default behavior of this method is to call `StateManager#getViewState(javax.faces.context.FacesContext)` on the wrapped `StateManager` object.
public StateManager	getWrapped() Implements javax.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 javax.faces.application.StateManager.isSavingStateInClient. The default behavior of this method is to call `StateManager#isSavingStateInClient(javax.faces.context.FacesContext)` on the wrapped `StateManager` object.
protected void	restoreComponentState(FacesContext `FacesContext` for the current request context, UIViewRoot `UIViewRoot` returned by a previous call to `restoreTreeStructure()` viewRoot, String the renderKitId used to render this response. Must not be `null`. renderKitId) Overrides javax.faces.application.StateManager.restoreComponentState. The default behavior of this method is to call `StateManager#restoreComponentState(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot, String)` on the wrapped `StateManager` object.
protected UIViewRoot	restoreTreeStructure(FacesContext `FacesContext` for the current request context, String View identifier of the view to be restored viewId, String the renderKitId used to render this response. Must not be `null`. renderKitId) Overrides javax.faces.application.StateManager.restoreTreeStructure. The default behavior of this method is to call `StateManager#restoreTreeStructure(javax.faces.context.FacesContext, String, String)` on the wrapped `StateManager` object.
public UIViewRoot	restoreView(FacesContext `FacesContext` for the current request context, String View identifier of the view to be restored viewId, String the renderKitId used to render this response. Must not be `null`. renderKitId) Implements abstract javax.faces.application.StateManager.restoreView. The default behavior of this method is to call `StateManager#restoreView(javax.faces.context.FacesContext, String, String)` on the wrapped `StateManager` object.
public StateManager.SerializedView	saveSerializedView(FacesContext `FacesContext` for the current request context) Overrides javax.faces.application.StateManager.saveSerializedView. Deprecated as a consequence of `StateManager.SerializedView` being deprecated. The default behavior of this method is to call `StateManager#saveSerializedView(javax.faces.context.FacesContext)` on the wrapped `StateManager` object.
public Object	saveView(FacesContext `FacesContext` for the current request context) Overrides javax.faces.application.StateManager.saveView. The default behavior of this method is to call `StateManager#saveView(javax.faces.context.FacesContext)` on the wrapped `StateManager` object.
public void	writeState(FacesContext `FacesContext` for the current request context, Object the Serializable state to be written, as returned by `saveSerializedView` state) Overrides javax.faces.application.StateManager.writeState. The default behavior of this method is to call `StateManager#writeState(javax.faces.context.FacesContext, java.lang.Object)` on the wrapped `StateManager` object.
public void	writeState(FacesContext `FacesContext` for the current request context, StateManager.SerializedView the serialized state to be written state) Overrides javax.faces.application.StateManager.writeState. Deprecated as a consequence of `StateManager.SerializedView` being deprecated. The default behavior of this method is to call `StateManager#writeState(javax.faces.context.FacesContext, javax.faces.application.StateManager.SerializedView)` on the wrapped `StateManager` object.

wrapped	back to summary
private StateManager wrapped

StateManagerWrapper	back to summary
public StateManagerWrapper() Deprecated Use the other constructor taking the implementation being wrapped. Annotations @Deprecated

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

Method Detail

getComponentStateToSave back to summary

getComponentStateToSave	back to summary
protected Object getComponentStateToSave(FacesContext context) Overrides javax.faces.application.StateManager.getComponentStateToSave. The default behavior of this method is to call `StateManager#getComponentStateToSave(javax.faces.context.FacesContext)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from javax.faces.application.StateManager.getComponentStateToSave. `FacesContext` for the current request Returns:Object Doc from javax.faces.application.StateManager.getComponentStateToSave. the component state, or null. Annotations @Override Since 1.2 See Also `StateManager#getComponentStateToSave(javax.faces.context.FacesContext)`

protected Object getComponentStateToSave(FacesContext context)

Overrides javax.faces.application.StateManager.getComponentStateToSave.

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

Parameters

context:FacesContext

Doc from javax.faces.application.StateManager.getComponentStateToSave.

FacesContext for the current request

Returns:Object

Doc from javax.faces.application.StateManager.getComponentStateToSave.

the component state, or null.

Annotations

@Override

Since

1.2

getTreeStructureToSave back to summary

getTreeStructureToSave	back to summary
protected Object getTreeStructureToSave(FacesContext context) Overrides javax.faces.application.StateManager.getTreeStructureToSave. The default behavior of this method is to call `StateManager#getTreeStructureToSave(javax.faces.context.FacesContext)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from javax.faces.application.StateManager.getTreeStructureToSave. `FacesContext` for the current request Returns:Object Doc from javax.faces.application.StateManager.getTreeStructureToSave. the tree structure, or null. Annotations @Override Since 1.2 See Also `StateManager#getTreeStructureToSave(javax.faces.context.FacesContext)`

protected Object getTreeStructureToSave(FacesContext context)

Overrides javax.faces.application.StateManager.getTreeStructureToSave.

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

Parameters

context:FacesContext

Doc from javax.faces.application.StateManager.getTreeStructureToSave.

FacesContext for the current request

Returns:Object

Doc from javax.faces.application.StateManager.getTreeStructureToSave.

the tree structure, or null.

Annotations

@Override

Since

1.2

getViewState back to summary

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

public String getViewState(FacesContext context)

Overrides javax.faces.application.StateManager.getViewState.

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

Parameters

context:FacesContext

Doc from javax.faces.application.StateManager.getViewState.

FacesContext for the current request

Returns:String

Doc from javax.faces.application.StateManager.getViewState.

the view state.

Annotations

@Override

Since

2.0

getWrapped	back to summary
public StateManager getWrapped() Implements javax.faces.FacesWrapper.getWrapped. Doc from javax.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 javax.faces.FacesWrapper.getWrapped.

Doc from javax.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 javax.faces.application.StateManager.isSavingStateInClient. The default behavior of this method is to call `StateManager#isSavingStateInClient(javax.faces.context.FacesContext)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from javax.faces.application.StateManager.isSavingStateInClient. the Faces context. Returns:boolean Doc from javax.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(javax.faces.context.FacesContext)`

public boolean isSavingStateInClient(FacesContext context)

Overrides javax.faces.application.StateManager.isSavingStateInClient.

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

Parameters

context:FacesContext

Doc from javax.faces.application.StateManager.isSavingStateInClient.

the Faces context.

Returns:boolean

Doc from javax.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

restoreComponentState back to summary

restoreComponentState	back to summary
protected void restoreComponentState(FacesContext context, UIViewRoot viewRoot, String renderKitId) Overrides javax.faces.application.StateManager.restoreComponentState. The default behavior of this method is to call `StateManager#restoreComponentState(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot, String)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from javax.faces.application.StateManager.restoreComponentState. `FacesContext` for the current request viewRoot:UIViewRoot Doc from javax.faces.application.StateManager.restoreComponentState. `UIViewRoot` returned by a previous call to `restoreTreeStructure()` renderKitId:String Doc from javax.faces.application.StateManager.restoreComponentState. the renderKitId used to render this response. Must not be `null`. Annotations @Override Since 1.2 See Also `StateManager#restoreComponentState(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot, String)`

protected void restoreComponentState(FacesContext context, UIViewRoot viewRoot, String renderKitId)

Overrides javax.faces.application.StateManager.restoreComponentState.

The default behavior of this method is to call StateManager#restoreComponentState(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot, String) on the wrapped StateManager object.

Parameters

context:FacesContext

Doc from javax.faces.application.StateManager.restoreComponentState.

FacesContext for the current request

viewRoot:UIViewRoot

Doc from javax.faces.application.StateManager.restoreComponentState.

UIViewRoot returned by a previous call to restoreTreeStructure()

renderKitId:String

Doc from javax.faces.application.StateManager.restoreComponentState.

the renderKitId used to render this response. Must not be null.

Annotations

@Override

Since

1.2

restoreTreeStructure back to summary

restoreTreeStructure	back to summary
protected UIViewRoot restoreTreeStructure(FacesContext context, String viewId, String renderKitId) Overrides javax.faces.application.StateManager.restoreTreeStructure. The default behavior of this method is to call `StateManager#restoreTreeStructure(javax.faces.context.FacesContext, String, String)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from javax.faces.application.StateManager.restoreTreeStructure. `FacesContext` for the current request viewId:String Doc from javax.faces.application.StateManager.restoreTreeStructure. View identifier of the view to be restored renderKitId:String Doc from javax.faces.application.StateManager.restoreTreeStructure. the renderKitId used to render this response. Must not be `null`. Returns:UIViewRoot Doc from javax.faces.application.StateManager.restoreTreeStructure. the view root, or `null`. Annotations @Override Since 1.2 See Also `StateManager#restoreTreeStructure(javax.faces.context.FacesContext, String, String)`

protected UIViewRoot restoreTreeStructure(FacesContext context, String viewId, String renderKitId)

Overrides javax.faces.application.StateManager.restoreTreeStructure.

The default behavior of this method is to call StateManager#restoreTreeStructure(javax.faces.context.FacesContext, String, String) on the wrapped StateManager object.

Parameters

context:FacesContext

Doc from javax.faces.application.StateManager.restoreTreeStructure.

FacesContext for the current request

viewId:String

Doc from javax.faces.application.StateManager.restoreTreeStructure.

View identifier of the view to be restored

renderKitId:String

Doc from javax.faces.application.StateManager.restoreTreeStructure.

the renderKitId used to render this response. Must not be null.

Returns:UIViewRoot

Doc from javax.faces.application.StateManager.restoreTreeStructure.

the view root, or null.

Annotations

@Override

Since

1.2

restoreView back to summary

restoreView	back to summary
public UIViewRoot restoreView(FacesContext context, String viewId, String renderKitId) Implements abstract javax.faces.application.StateManager.restoreView. The default behavior of this method is to call `StateManager#restoreView(javax.faces.context.FacesContext, String, String)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from javax.faces.application.StateManager.restoreView. `FacesContext` for the current request viewId:String Doc from javax.faces.application.StateManager.restoreView. View identifier of the view to be restored renderKitId:String Doc from javax.faces.application.StateManager.restoreView. the renderKitId used to render this response. Must not be `null`. Returns:UIViewRoot Doc from javax.faces.application.StateManager.restoreView. the view root, or `null`. Annotations @Override Since 1.2 See Also `StateManager#restoreView(javax.faces.context.FacesContext, String, String)`

public UIViewRoot restoreView(FacesContext context, String viewId, String renderKitId)

Implements abstract javax.faces.application.StateManager.restoreView.

The default behavior of this method is to call StateManager#restoreView(javax.faces.context.FacesContext, String, String) on the wrapped StateManager object.

Parameters

context:FacesContext

Doc from javax.faces.application.StateManager.restoreView.

FacesContext for the current request

viewId:String

Doc from javax.faces.application.StateManager.restoreView.

View identifier of the view to be restored

renderKitId:String

Doc from javax.faces.application.StateManager.restoreView.

the renderKitId used to render this response. Must not be null.

Returns:UIViewRoot

Doc from javax.faces.application.StateManager.restoreView.

the view root, or null.

Annotations

@Override

Since

1.2

saveSerializedView back to summary

saveSerializedView	back to summary
public StateManager.SerializedView saveSerializedView(FacesContext context) Overrides javax.faces.application.StateManager.saveSerializedView. Deprecated as a consequence of `StateManager.SerializedView` being deprecated. See corresponding docs for further information. The default behavior of this method is to call `StateManager#saveSerializedView(javax.faces.context.FacesContext)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from javax.faces.application.StateManager.saveSerializedView. `FacesContext` for the current request Returns:StateManager.SerializedView Doc from javax.faces.application.StateManager.saveSerializedView. the serialized view, or null. Annotations @Override Since 1.2 See Also `StateManager#saveSerializedView(javax.faces.context.FacesContext)`

public StateManager.SerializedView saveSerializedView(FacesContext context)

Overrides javax.faces.application.StateManager.saveSerializedView.

Deprecated

as a consequence of StateManager.SerializedView being deprecated. See corresponding docs for further information.

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

Parameters

context:FacesContext

Doc from javax.faces.application.StateManager.saveSerializedView.

FacesContext for the current request

Returns:StateManager.SerializedView

Doc from javax.faces.application.StateManager.saveSerializedView.

the serialized view, or null.

Annotations

@Override

Since

1.2

saveView back to summary

saveView	back to summary
public Object saveView(FacesContext context) Overrides javax.faces.application.StateManager.saveView. The default behavior of this method is to call `StateManager#saveView(javax.faces.context.FacesContext)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from javax.faces.application.StateManager.saveView. `FacesContext` for the current request Returns:Object Doc from javax.faces.application.StateManager.saveView. the saved view. Annotations @Override Since 1.2 See Also `StateManager#saveView(javax.faces.context.FacesContext)`

public Object saveView(FacesContext context)

Overrides javax.faces.application.StateManager.saveView.

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

Parameters

context:FacesContext

Doc from javax.faces.application.StateManager.saveView.

FacesContext for the current request

Returns:Object

Doc from javax.faces.application.StateManager.saveView.

the saved view.

Annotations

@Override

Since

1.2

writeState back to summary

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

public void writeState(FacesContext context, Object state) throws IOException

Overrides javax.faces.application.StateManager.writeState.

The default behavior of this method is to call StateManager#writeState(javax.faces.context.FacesContext, java.lang.Object) on the wrapped StateManager object.

Parameters

context:FacesContext

Doc from javax.faces.application.StateManager.writeState.

FacesContext for the current request

state:Object

Doc from javax.faces.application.StateManager.writeState.

the Serializable state to be written, as returned by saveSerializedView

Annotations

@Override

Exceptions

IOException:

Doc from javax.faces.application.StateManager.writeState.

when an I/O error occurs.

Since

1.2

writeState back to summary

writeState	back to summary
public void writeState(FacesContext context, StateManager.SerializedView state) throws IOException Overrides javax.faces.application.StateManager.writeState. Deprecated as a consequence of `StateManager.SerializedView` being deprecated. See corresponding docs for further information. The default behavior of this method is to call `StateManager#writeState(javax.faces.context.FacesContext, javax.faces.application.StateManager.SerializedView)` on the wrapped `StateManager` object. Parameters context:FacesContext Doc from javax.faces.application.StateManager.writeState. `FacesContext` for the current request state:StateManager.SerializedView Doc from javax.faces.application.StateManager.writeState. the serialized state to be written Annotations @Override Exceptions IOException: Doc from javax.faces.application.StateManager.writeState. when an I/O error occurs. Since 1.2 See Also `StateManager#writeState(javax.faces.context.FacesContext, javax.faces.application.StateManager.SerializedView)`