JavaEE Web API 8.0.1 · javax.faces.application.StateManager

Modifier and Type	Class and Description
public class	StateManager.SerializedView Deprecated This class was not marked `Serializable` in the 1.0 version of the spec. Convenience struct for encapsulating tree structure and component state.

Modifier and Type	Field and Description
public static final String	FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME The runtime must interpret the value of this parameter as a comma separated list of view IDs, each of which must have their state saved using the state saving mechanism specified in JSF 1.2.
public static final String	IS_BUILDING_INITIAL_STATE Marker within the `FacesContext` attributes map to indicate we are marking initial state, so the `markInitialState()` method of iterating components such as `javax.faces.component.UIData` could recognize this fact and save the initial state of descendents.
private static final String	IS_CALLED_FROM_API_CLASS
public static final String	IS_SAVING_STATE Marker within the `FacesContext` attributes map to indicate we are saving state.
public static final String	PARTIAL_STATE_SAVING_PARAM_NAME The `ServletContext` init parameter consulted by the runtime to determine if the partial state saving mechanism should be used.
private Boolean	savingStateInClient
public static final String	SERIALIZE_SERVER_STATE_PARAM_NAME If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the javax.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable.
public static final String	STATE_SAVING_METHOD_CLIENT Constant value for the initialization parameter named by the `STATE_SAVING_METHOD_PARAM_NAME` that indicates state saving should take place on the client.
public static final String	STATE_SAVING_METHOD_PARAM_NAME The `ServletContext` init parameter consulted by the `StateManager` to tell where the state should be saved.
public static final String	STATE_SAVING_METHOD_SERVER Constant value for the initialization parameter named by the `STATE_SAVING_METHOD_PARAM_NAME` that indicates state saving should take place on the server.

Access	Constructor and Description
public	StateManager()

Method Summary

Modifier and Type	Method and Description
protected Object	Returns: the component state, or null. getComponentStateToSave(FacesContext `FacesContext` for the current request context) Deprecated the distinction between tree structure and component state is now an implementation detail. The default implementation returns `null`. Convenience method, which must be called by `saveSerializedView()`, to construct and return a `Serializable` object that represents the state of all component properties, attributes, and attached objects, for the entire component tree (including children and facets) of this view.
protected Object	Returns: the tree structure, or null. getTreeStructureToSave(FacesContext `FacesContext` for the current request context) Deprecated the distinction between tree structure and component state is now an implementation detail. The default implementation returns `null`. Convenience method, which must be called by `saveSerializedView()`, to construct and return a `Serializable` object that represents the structure of the entire component tree (including children and facets) of this view.
public String	Returns: the view state. getViewState(FacesContext `FacesContext` for the current request context) Convenience method to return the view state as a `String` with no `RenderKit` specific markup.
public boolean	Returns: `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. isSavingStateInClient(FacesContext the Faces context. context) Method to determine if the state is saved on the client.
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) Deprecated the distinction between tree structure and component state is now an implementation detail. The default implementation does nothing. Convenience method, which must be called by `restoreView()`, to restore the attributes, properties, and attached objects of all components in the restored component tree.
protected UIViewRoot	Returns: the view root, or `null`. 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) Deprecated the distinction between tree structure and component state is now an implementation detail. The default implementation returns `null`. Convenience method, which must be called by `restoreView()`, to construct and return a `UIViewRoot` instance (populated with children and facets) representing the tree structure of the component tree being restored.
public abstract UIViewRoot	Returns: the view root, or `null`. 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) Deprecated The functionality of this method is now handled by `javax.faces.view.StateManagementStrategy#restoreView`.
public StateManager.SerializedView	Returns: the serialized view, or null. saveSerializedView(FacesContext `FacesContext` for the current request context) Deprecated this has been replaced by `saveView`. Return the tree structure and component state information for the view contained in the specified `FacesContext` instance as an object of type `StateManager.SerializedView`.
public Object	Returns: the saved view. saveView(FacesContext `FacesContext` for the current request context) Deprecated The functionality of this method is now handled by `javax.faces.view.StateManagementStrategy#saveView`.
public void	writeState(FacesContext `FacesContext` for the current request context, Object the Serializable state to be written, as returned by `saveSerializedView` state) Save the state represented in the specified state `Object` instance, in an implementation dependent manner.
public void	writeState(FacesContext `FacesContext` for the current request context, StateManager.SerializedView the serialized state to be written state) Deprecated This method has been replaced by `writeState(javax.faces.context.FacesContext, java.lang.Object)`. Save the state represented in the specified `SerializedView` isntance, in an implementation dependent manner.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME	back to summary
public static final String FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME The runtime must interpret the value of this parameter as a comma separated list of view IDs, each of which must have their state saved using the state saving mechanism specified in JSF 1.2.

IS_BUILDING_INITIAL_STATE back to summary

IS_BUILDING_INITIAL_STATE	back to summary
public static final String IS_BUILDING_INITIAL_STATE Marker within the `FacesContext` attributes map to indicate we are marking initial state, so the `markInitialState()` method of iterating components such as `javax.faces.component.UIData` could recognize this fact and save the initial state of descendents. Since 2.1

public static final String IS_BUILDING_INITIAL_STATE

Marker within the FacesContext attributes map to indicate we are marking initial state, so the markInitialState() method of iterating components such as javax.faces.component.UIData could recognize this fact and save the initial state of descendents.

Since: 2.1

IS_CALLED_FROM_API_CLASS	back to summary
private static final String IS_CALLED_FROM_API_CLASS

IS_SAVING_STATE	back to summary
public static final String IS_SAVING_STATE Marker within the `FacesContext` attributes map to indicate we are saving state. The implementation must set this marker into the map before starting the state saving traversal and the marker must be cleared, in a finally block, after the traversal is complete.

PARTIAL_STATE_SAVING_PARAM_NAME back to summary

PARTIAL_STATE_SAVING_PARAM_NAME	back to summary
public static final String PARTIAL_STATE_SAVING_PARAM_NAME The `ServletContext` init parameter consulted by the runtime to determine if the partial state saving mechanism should be used. If undefined, the runtime must determine the version level of the application. For applications versioned at 1.2 and under, the runtime must not use the partial state saving mechanism. For applications versioned at 2.0 and above, the runtime must use the partial state saving mechanism. If this parameter is defined, and the application is versioned at 1.2 and under, the runtime must not use the partial state saving mechanism. Otherwise, If this param is defined, and calling `toLowerCase().equals("true")` on a `String` representation of its value returns `true`, the runtime must use partial state mechanism. Otherwise the partial state saving mechanism must not be used. Since 2.0

public static final String PARTIAL_STATE_SAVING_PARAM_NAME

The ServletContext init parameter consulted by the runtime to determine if the partial state saving mechanism should be used.

If undefined, the runtime must determine the version level of the application.

For applications versioned at 1.2 and under, the runtime must not use the partial state saving mechanism.
For applications versioned at 2.0 and above, the runtime must use the partial state saving mechanism.

If this parameter is defined, and the application is versioned at 1.2 and under, the runtime must not use the partial state saving mechanism. Otherwise, If this param is defined, and calling toLowerCase().equals("true") on a String representation of its value returns true, the runtime must use partial state mechanism. Otherwise the partial state saving mechanism must not be used.

Since: 2.0

savingStateInClient	back to summary
private Boolean savingStateInClient

SERIALIZE_SERVER_STATE_PARAM_NAME	back to summary
public static final String SERIALIZE_SERVER_STATE_PARAM_NAME If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the javax.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable. The intent of this parameter is to ensure that the act of writing out the state to an ObjectOutputStream would not throw a NotSerializableException, but the runtime is not required verify this before saving the state. Since 2.2

SERIALIZE_SERVER_STATE_PARAM_NAME

back to summary

public static final String SERIALIZE_SERVER_STATE_PARAM_NAME

If this param is set, and calling toLowerCase().equals("true") on a String representation of its value returns true, and the javax.faces.STATE_SAVING_METHOD is set to "server" (as indicated below), the server state must be guaranteed to be Serializable such that the aggregate state implements java.io.Serializable. The intent of this parameter is to ensure that the act of writing out the state to an ObjectOutputStream would not throw a NotSerializableException, but the runtime is not required verify this before saving the state.

Since: 2.2

STATE_SAVING_METHOD_CLIENT	back to summary
public static final String STATE_SAVING_METHOD_CLIENT Constant value for the initialization parameter named by the `STATE_SAVING_METHOD_PARAM_NAME` that indicates state saving should take place on the client.

STATE_SAVING_METHOD_PARAM_NAME back to summary

STATE_SAVING_METHOD_PARAM_NAME	back to summary
public static final String STATE_SAVING_METHOD_PARAM_NAME The `ServletContext` init parameter consulted by the `StateManager` to tell where the state should be saved. Valid values are given as the values of the constants: `STATE_SAVING_METHOD_CLIENT` or `STATE_SAVING_METHOD_SERVER`. If this parameter is not specified, the default value is the value of the constant `STATE_SAVING_METHOD_CLIENT`.

public static final String STATE_SAVING_METHOD_PARAM_NAME

The ServletContext init parameter consulted by the StateManager to tell where the state should be saved. Valid values are given as the values of the constants: STATE_SAVING_METHOD_CLIENT or STATE_SAVING_METHOD_SERVER.

If this parameter is not specified, the default value is the value of the constant STATE_SAVING_METHOD_CLIENT.

STATE_SAVING_METHOD_SERVER	back to summary
public static final String STATE_SAVING_METHOD_SERVER Constant value for the initialization parameter named by the `STATE_SAVING_METHOD_PARAM_NAME` that indicates state saving should take place on the server.

Constructor Detail

StateManager	back to summary
public StateManager()

Method Detail

getComponentStateToSave back to summary

getComponentStateToSave	back to summary
protected Object getComponentStateToSave(FacesContext context) Deprecated the distinction between tree structure and component state is now an implementation detail. The default implementation returns `null`. Convenience method, which must be called by `saveSerializedView()`, to construct and return a `Serializable` object that represents the state of all component properties, attributes, and attached objects, for the entire component tree (including children and facets) of this view. Components may opt-out of being included in the component state by setting their `transient` property to `true`. This must cause the component itself, as well as all of that component's children and facets, to be omitted from the saved component state information. Parameters context:FacesContext `FacesContext` for the current request Returns:Object the component state, or null.

protected Object getComponentStateToSave(FacesContext context)

Deprecated

the distinction between tree structure and component state is now an implementation detail. The default implementation returns null.

Convenience method, which must be called by saveSerializedView(), to construct and return a Serializable object that represents the state of all component properties, attributes, and attached objects, for the entire component tree (including children and facets) of this view.

Components may opt-out of being included in the component state by setting their transient property to true. This must cause the component itself, as well as all of that component's children and facets, to be omitted from the saved component state information.

Parameters

context:FacesContext: FacesContext for the current request

Returns:Object

the component state, or null.

getTreeStructureToSave back to summary

getTreeStructureToSave	back to summary
protected Object getTreeStructureToSave(FacesContext context) Deprecated the distinction between tree structure and component state is now an implementation detail. The default implementation returns `null`. Convenience method, which must be called by `saveSerializedView()`, to construct and return a `Serializable` object that represents the structure of the entire component tree (including children and facets) of this view. Components may opt-out of being included in the tree structure by setting their `transient` property to `true`. This must cause the component itself, as well as all of that component's children and facets, to be omitted from the saved tree structure information. Parameters context:FacesContext `FacesContext` for the current request Returns:Object the tree structure, or null.

protected Object getTreeStructureToSave(FacesContext context)

Deprecated

the distinction between tree structure and component state is now an implementation detail. The default implementation returns null.

Convenience method, which must be called by saveSerializedView(), to construct and return a Serializable object that represents the structure of the entire component tree (including children and facets) of this view.

Components may opt-out of being included in the tree structure by setting their transient property to true. This must cause the component itself, as well as all of that component's children and facets, to be omitted from the saved tree structure information.

Parameters

context:FacesContext: FacesContext for the current request

Returns:Object

the tree structure, or null.

getViewState back to summary

getViewState	back to summary
public String getViewState(FacesContext context) Convenience method to return the view state as a `String` with no `RenderKit` specific markup. This default implementation of this method will call `saveView(javax.faces.context.FacesContext)` and passing the result to and returning the resulting value from `ResponseStateManager#getViewState(javax.faces.context.FacesContext, Object)`. Parameters context:FacesContext `FacesContext` for the current request Returns:String the view state. Since 2.0

public String getViewState(FacesContext context)

Convenience method to return the view state as a String with no RenderKit specific markup. This default implementation of this method will call saveView(javax.faces.context.FacesContext) and passing the result to and returning the resulting value from ResponseStateManager#getViewState(javax.faces.context.FacesContext, Object).

Parameters

context:FacesContext: FacesContext for the current request

Returns:String

the view state.

Since

2.0

isSavingStateInClient back to summary

isSavingStateInClient	back to summary
public boolean isSavingStateInClient(FacesContext context) Method to determine if the state is saved on the client. Parameters context:FacesContext the Faces context. Returns:boolean `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. Exceptions NullPointerException: if `context` is `null`.

public boolean isSavingStateInClient(FacesContext context)

Method to determine if the state is saved on the client.

Parameters

context:FacesContext: the Faces context.

Returns:boolean

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.

Exceptions

NullPointerException:: if context is null.

restoreComponentState back to summary

restoreComponentState	back to summary
protected void restoreComponentState(FacesContext context, UIViewRoot viewRoot, String renderKitId) Deprecated the distinction between tree structure and component state is now an implementation detail. The default implementation does nothing. Convenience method, which must be called by `restoreView()`, to restore the attributes, properties, and attached objects of all components in the restored component tree. Parameters context:FacesContext `FacesContext` for the current request viewRoot:UIViewRoot `UIViewRoot` returned by a previous call to `restoreTreeStructure()` renderKitId:String the renderKitId used to render this response. Must not be `null`. Exceptions IllegalArgumentException: if `renderKitId` is `null`.

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

Deprecated

the distinction between tree structure and component state is now an implementation detail. The default implementation does nothing.

Convenience method, which must be called by restoreView(), to restore the attributes, properties, and attached objects of all components in the restored component tree.

Parameters

context:FacesContext: FacesContext for the current request
viewRoot:UIViewRoot: UIViewRoot returned by a previous call to restoreTreeStructure()
renderKitId:String: the renderKitId used to render this response. Must not be null.

Exceptions

IllegalArgumentException:: if renderKitId is null.

restoreTreeStructure back to summary

restoreTreeStructure	back to summary
protected UIViewRoot restoreTreeStructure(FacesContext context, String viewId, String renderKitId) Deprecated the distinction between tree structure and component state is now an implementation detail. The default implementation returns `null`. Convenience method, which must be called by `restoreView()`, to construct and return a `UIViewRoot` instance (populated with children and facets) representing the tree structure of the component tree being restored. If no saved state information is available, return `null` instead. Parameters context:FacesContext `FacesContext` for the current request viewId:String View identifier of the view to be restored renderKitId:String the renderKitId used to render this response. Must not be `null`. Returns:UIViewRoot the view root, or `null`. Exceptions IllegalArgumentException: if `renderKitId` is `null`.

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

Deprecated

the distinction between tree structure and component state is now an implementation detail. The default implementation returns null.

Convenience method, which must be called by restoreView(), to construct and return a UIViewRoot instance (populated with children and facets) representing the tree structure of the component tree being restored. If no saved state information is available, return null instead.

Parameters

context:FacesContext: FacesContext for the current request
viewId:String: View identifier of the view to be restored
renderKitId:String: the renderKitId used to render this response. Must not be null.

Returns:UIViewRoot

the view root, or null.

Exceptions

IllegalArgumentException:: if renderKitId is null.

restoreView back to summary

restoreView	back to summary
public abstract UIViewRoot restoreView(FacesContext context, String viewId, String renderKitId) Deprecated The functionality of this method is now handled by `javax.faces.view.StateManagementStrategy#restoreView`. Restore the tree structure and the component state of the view for the specified `viewId`, in an implementation dependent manner, and return the restored `UIViewRoot`. If there is no saved state information available for this `viewId`, return `null` instead. This method must consult the context initialization parameter named by the symbolic constant `StateManager.STATE_SAVING_METHOD_PARAM_NAME` to determine whether state should be saved on the client or the server. If not present, client side state saving is assumed. If the init parameter indicates that client side state saving should be used, this method must call the `getTreeStructureToRestore()` and (if the previous method call returned a non-null value) `getComponentStateToRestore()` methods of the `ResponseStateManager` instance provided by the `RenderKit` responsible for this view. Parameters context:FacesContext `FacesContext` for the current request viewId:String View identifier of the view to be restored renderKitId:String the renderKitId used to render this response. Must not be `null`. Returns:UIViewRoot the view root, or `null`. Annotations @Deprecated Exceptions IllegalArgumentException: if `renderKitId` is `null`.

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

Deprecated

The functionality of this method is now handled by javax.faces.view.StateManagementStrategy#restoreView. Restore the tree structure and the component state of the view for the specified viewId, in an implementation dependent manner, and return the restored UIViewRoot. If there is no saved state information available for this viewId, return null instead.

This method must consult the context initialization parameter named by the symbolic constant StateManager.STATE_SAVING_METHOD_PARAM_NAME to determine whether state should be saved on the client or the server. If not present, client side state saving is assumed.

If the init parameter indicates that client side state saving should be used, this method must call the getTreeStructureToRestore() and (if the previous method call returned a non-null value) getComponentStateToRestore() methods of the ResponseStateManager instance provided by the RenderKit responsible for this view.

Parameters

context:FacesContext: FacesContext for the current request
viewId:String: View identifier of the view to be restored
renderKitId:String: the renderKitId used to render this response. Must not be null.

Returns:UIViewRoot

the view root, or null.

Annotations

@Deprecated

Exceptions

IllegalArgumentException:: if renderKitId is null.

saveSerializedView back to summary

saveSerializedView	back to summary
public StateManager.SerializedView saveSerializedView(FacesContext context) Deprecated this has been replaced by `saveView`. The default implementation calls `saveView` and inspects the return. If the return is an `Object []`, it casts the result to an `Object []` wrapping the first and second elements in an instance of `SerializedView`, which it then returns. Otherwise, it returns `null` Return the tree structure and component state information for the view contained in the specified `FacesContext` instance as an object of type `StateManager.SerializedView`. If there is no state information to be saved, return `null` instead. Components may opt out of being included in the serialized view by setting their `transient` property to `true`. This must cause the component itself, as well as all of that component's children and facets, to be omitted from the saved tree structure and component state information. This method must also enforce the rule that, for components with non-null `id`s, all components that are descendants of the same nearest `NamingContainer` must have unique identifiers. Parameters context:FacesContext `FacesContext` for the current request Returns:StateManager.SerializedView the serialized view, or null. Exceptions IllegalStateException: if more than one component or facet within the same `NamingContainer` in this view has the same non-`null` component id

public StateManager.SerializedView saveSerializedView(FacesContext context)

Deprecated

this has been replaced by saveView. The default implementation calls saveView and inspects the return. If the return is an Object [], it casts the result to an Object [] wrapping the first and second elements in an instance of SerializedView, which it then returns. Otherwise, it returns null

Return the tree structure and component state information for the view contained in the specified FacesContext instance as an object of type StateManager.SerializedView. If there is no state information to be saved, return null instead.

Components may opt out of being included in the serialized view by setting their transient property to true. This must cause the component itself, as well as all of that component's children and facets, to be omitted from the saved tree structure and component state information.

This method must also enforce the rule that, for components with non-null ids, all components that are descendants of the same nearest NamingContainer must have unique identifiers.

Parameters

context:FacesContext: FacesContext for the current request

Returns:StateManager.SerializedView

the serialized view, or null.

Exceptions

IllegalStateException:: if more than one component or facet within the same NamingContainer in this view has the same non-null component id

saveView back to summary

saveView	back to summary
public Object saveView(FacesContext context) Deprecated The functionality of this method is now handled by `javax.faces.view.StateManagementStrategy#saveView`. Return an opaque `Object` containing sufficient information for this same instance to restore the state of the current `UIViewRoot` on a subsequent request. The returned object must implement `java.io.Serializable`. If there is no state information to be saved, return `null` instead. Components may opt out of being included in the serialized view by setting their `transient` property to `true`. This must cause the component itself, as well as all of that component's children and facets, to be omitted from the saved tree structure and component state information. This method must also enforce the rule that, for components with non-null `id`s, all components that are descendants of the same nearest `NamingContainer` must have unique identifiers. For backwards compatability with existing `StateManager` implementations, the default implementation of this method calls `saveSerializedView` and creates and returns a two element `Object` array with element zero containing the `structure` property and element one containing the `state` property of the `SerializedView`. Parameters context:FacesContext `FacesContext` for the current request Returns:Object the saved view. Annotations @Deprecated Exceptions IllegalStateException: if more than one component or facet within the same `NamingContainer` in this view has the same non-`null` component id Since 1.2

public Object saveView(FacesContext context)

Deprecated

The functionality of this method is now handled by javax.faces.view.StateManagementStrategy#saveView. Return an opaque Object containing sufficient information for this same instance to restore the state of the current UIViewRoot on a subsequent request. The returned object must implement java.io.Serializable. If there is no state information to be saved, return null instead.

This method must also enforce the rule that, for components with non-null ids, all components that are descendants of the same nearest NamingContainer must have unique identifiers.

For backwards compatability with existing StateManager implementations, the default implementation of this method calls saveSerializedView and creates and returns a two element Object array with element zero containing the structure property and element one containing the state property of the SerializedView.

Parameters

context:FacesContext: FacesContext for the current request

Returns:Object

the saved view.

Annotations

@Deprecated

Exceptions

IllegalStateException:: if more than one component or facet within the same NamingContainer in this view has the same non-null component id

Since

1.2

writeState back to summary

writeState	back to summary
public void writeState(FacesContext context, Object state) throws IOException Save the state represented in the specified state `Object` instance, in an implementation dependent manner. This method will typically simply delegate the actual writing to the `writeState()` method of the `ResponseStateManager` instance provided by the `RenderKit` being used to render this view. This method assumes that the caller has positioned the `ResponseWriter` at the correct position for the saved state to be written. For backwards compatability with existing `StateManager` implementations, the default implementation of this method checks if the argument is an instance of `Object []` of length greater than or equal to two. If so, it creates a `SerializedView` instance with the tree structure coming from element zero and the component state coming from element one and calls through to `writeState(javax.faces.context.FacesContext, javax.faces.application.StateManager.SerializedView)`. If not, does nothing. Parameters context:FacesContext `FacesContext` for the current request state:Object the Serializable state to be written, as returned by `saveSerializedView` Exceptions IOException: when an I/O error occurs. Since 1.2

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

Save the state represented in the specified state Object instance, in an implementation dependent manner.

This method will typically simply delegate the actual writing to the writeState() method of the ResponseStateManager instance provided by the RenderKit being used to render this view. This method assumes that the caller has positioned the ResponseWriter at the correct position for the saved state to be written.

For backwards compatability with existing StateManager implementations, the default implementation of this method checks if the argument is an instance of Object [] of length greater than or equal to two. If so, it creates a SerializedView instance with the tree structure coming from element zero and the component state coming from element one and calls through to writeState(javax.faces.context.FacesContext, javax.faces.application.StateManager.SerializedView). If not, does nothing.

Parameters

context:FacesContext: FacesContext for the current request
state:Object: the Serializable state to be written, as returned by saveSerializedView

Exceptions

IOException:: 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 Deprecated This method has been replaced by `writeState(javax.faces.context.FacesContext, java.lang.Object)`. The default implementation calls the non-deprecated variant of the method passing an `Object []` as the second argument, where the first element of the array is the return from `getStructure()` and the second is the return from `getState()` on the argument `state`. Save the state represented in the specified `SerializedView` isntance, in an implementation dependent manner. This method must consult the context initialization parameter named by the symbolic constant `StateManager.STATE_SAVING_METHOD_PARAM_NAME` to determine whether state should be saved on the client or the server. If not present, client side state saving is assumed. If the init parameter indicates that client side state saving should be used, this method must delegate the actual writing to the `writeState()` method of the `ResponseStateManager` instance provided by the `RenderKit` being used to render this view. This method assumes that the caller has positioned the `ResponseWriter` at the correct position for the saved state to be written. Parameters context:FacesContext `FacesContext` for the current request state:StateManager.SerializedView the serialized state to be written Exceptions IOException: when an I/O error occurs.

public void writeState(FacesContext context, StateManager.SerializedView state) throws IOException

Deprecated

This method has been replaced by writeState(javax.faces.context.FacesContext, java.lang.Object). The default implementation calls the non-deprecated variant of the method passing an Object [] as the second argument, where the first element of the array is the return from getStructure() and the second is the return from getState() on the argument state.

Save the state represented in the specified SerializedView isntance, in an implementation dependent manner.

If the init parameter indicates that client side state saving should be used, this method must delegate the actual writing to the writeState() method of the ResponseStateManager instance provided by the RenderKit being used to render this view. This method assumes that the caller has positioned the ResponseWriter at the correct position for the saved state to be written.

Parameters

context:FacesContext: FacesContext for the current request
state:StateManager.SerializedView: the serialized state to be written

Exceptions

IOException:: when an I/O error occurs.

public abstract Class StateManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class StateManager.SerializedView

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail