javax.faces.component

Class ComponentStateHelper

java.lang.Object

javax.faces.component.ComponentStateHelper

All Implemented Interfaces:

StateHelper, StateHolder, TransientStateHelper, TransientStateHolder

class ComponentStateHelper
extends java.lang.Object
implements StateHelper, TransientStateHelper

A base implementation for maps which implement the PartialStateHolder and TransientStateHolder interfaces. This can be used as a base-class for all state-holder implementations in components, converters and validators and other implementations of the StateHolder interface.

Field Summary

Fields

Modifier and Type	Field and Description
private UIComponent	component
private java.util.Map<java.io.Serializable,java.lang.Object>	defaultMap
private java.util.Map<java.io.Serializable,java.lang.Object>	deltaMap
private boolean	isTransient
private java.util.Map<java.lang.Object,java.lang.Object>	transientState

Constructor Summary

Constructors

Constructor and Description
ComponentStateHelper(UIComponent component)

Method Summary

Modifier and Type	Method and Description
void	add(java.io.Serializable key, java.lang.Object value) Store the specified value in a List that is internal to the StateHelper.
java.lang.Object	eval(java.io.Serializable key) Attempts to find a value associated with the specified key, using the value expression collection from the component if no such value is found.
java.lang.Object	eval(java.io.Serializable key, java.lang.Object defaultValue) Performs the same logic as StateHelper.eval(java.io.Serializable) } but if no value is found, this will return the specified defaultValue
java.lang.Object	get(java.io.Serializable key) Get the object from the main-map.
java.lang.Object	getTransient(java.lang.Object key) Return the value currently associated with the specified key if any.
java.lang.Object	getTransient(java.lang.Object key, java.lang.Object defaultValue) Performs the same logic as TransientStateHelper.getTransient(java.lang.Object) } but if no value is found, this will return the specified defaultValue
boolean	isTransient() If true, the Object implementing this interface must not participate in state saving or restoring.
java.lang.Object	put(java.io.Serializable key, java.lang.Object value) Put the object in the main-map and/or the delta-map, if necessary.
java.lang.Object	put(java.io.Serializable key, java.lang.String mapKey, java.lang.Object value) Store the specified mapKey/value in a Map that is internal to the helper, and return the previously stored value.
java.lang.Object	putTransient(java.lang.Object key, java.lang.Object value) Return the previously stored value and store the specified key/value pair.
java.lang.Object	remove(java.io.Serializable key) We need to remove from both maps, if we do remove an existing key.
java.lang.Object	remove(java.io.Serializable key, java.lang.Object valueOrKey) Remove a value from the inner data structure.
private java.lang.Object	removeFromList(java.io.Serializable key, java.lang.Object value)
private java.lang.Object	removeFromMap(java.io.Serializable key, java.lang.String mapKey)
void	restoreState(FacesContext context, java.lang.Object state) One and only implementation of restore state.
void	restoreTransientState(FacesContext context, java.lang.Object state) Restore the "transient state" using the object passed as state.
private java.lang.Object	saveMap(FacesContext context, java.util.Map<java.io.Serializable,java.lang.Object> map)
java.lang.Object	saveState(FacesContext context) One and only implementation of save-state - makes all other implementations unnecessary.
java.lang.Object	saveTransientState(FacesContext context) Return the object containing related "transient states".
void	setTransient(boolean newTransientValue) Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

component

private UIComponent component

isTransient

private boolean isTransient

deltaMap

private java.util.Map<java.io.Serializable,java.lang.Object> deltaMap

defaultMap

private java.util.Map<java.io.Serializable,java.lang.Object> defaultMap

transientState

private java.util.Map<java.lang.Object,java.lang.Object> transientState

Constructor Detail

ComponentStateHelper

public ComponentStateHelper(UIComponent component)

Method Detail

put

public java.lang.Object put(java.io.Serializable key,
                            java.lang.Object value)

Put the object in the main-map and/or the delta-map, if necessary.

Specified by:

put in interface StateHelper

Parameters:

key -

value -

Returns:

the original value in the delta-map, if not present, the old value in the main map

remove

public java.lang.Object remove(java.io.Serializable key)

We need to remove from both maps, if we do remove an existing key.

Specified by:

remove in interface StateHelper

Parameters:

key -

Returns:

the removed object in the delta-map. if not present, the removed object from the main map

put

public java.lang.Object put(java.io.Serializable key,
                            java.lang.String mapKey,
                            java.lang.Object value)

Description copied from interface: StateHelper

Store the specified mapKey/value in a Map that is internal to the helper, and return the previously stored value. The Map will then be associated with key.

It's important to note for delta tracking that any modifications to the internal Map be made through this method or StateHelper.remove(java.io.Serializable, Object).

Specified by:

put in interface StateHelper

Parameters:

key - the key of the map itself

mapKey - the key within the internal map

value - the value for the key in the internal map

See Also:

StateHelper.put(java.io.Serializable, String, Object)

get

public java.lang.Object get(java.io.Serializable key)

Get the object from the main-map. As everything is written through from the delta-map to the main-map, this should be enough.

Specified by:

get in interface StateHelper

Parameters:

key -

Returns:

eval

public java.lang.Object eval(java.io.Serializable key)

Description copied from interface: StateHelper

Attempts to find a value associated with the specified key, using the value expression collection from the component if no such value is found.

Specified by:

eval in interface StateHelper

Parameters:

key - the name of the value in the internal map, or the name of a value expression in the components value expression collection.

See Also:

StateHelper.eval(java.io.Serializable)

eval

public java.lang.Object eval(java.io.Serializable key,
                             java.lang.Object defaultValue)

Description copied from interface: StateHelper

Performs the same logic as StateHelper.eval(java.io.Serializable) } but if no value is found, this will return the specified defaultValue

Specified by:

eval in interface StateHelper

Parameters:

key - the key for which the value should be returned.

defaultValue - the value to return if no value is found in the call to eval().

See Also:

StateHelper.eval(java.io.Serializable, Object)

add

public void add(java.io.Serializable key,
                java.lang.Object value)

Description copied from interface: StateHelper

Store the specified value in a List that is internal to the StateHelper.

It's important to note for delta tracking that any modifications to the internal List be made through this method or StateHelper.remove(java.io.Serializable, Object).

Specified by:

add in interface StateHelper

Parameters:

key - the key for which the value should be returned.

value - the value to add

See Also:

StateHelper.add(java.io.Serializable, Object)

remove

public java.lang.Object remove(java.io.Serializable key,
                               java.lang.Object valueOrKey)

Description copied from interface: StateHelper

Remove a value from the inner data structure. Look in the inner data structure for the value at the given key. If the value is a Map, remove and return the value under the key given by the valueOrKey argument. If the value is a Collection, simply remove the value given by the argument valueOrKey and return null.

Specified by:

remove in interface StateHelper

Parameters:

key - the key of in the inner data structure whose value is a Collection or Map

valueOrKey - the value or key to be removed.

See Also:

StateHelper.remove(java.io.Serializable, Object)

saveState

public java.lang.Object saveState(FacesContext context)

One and only implementation of save-state - makes all other implementations unnecessary.

Specified by:

saveState in interface StateHolder

Parameters:

context -

Returns:

the saved state

restoreState

public void restoreState(FacesContext context,
                         java.lang.Object state)

One and only implementation of restore state. Makes all other implementations unnecessary.

Specified by:

restoreState in interface StateHolder

Parameters:

context - FacesContext

state - the state to be restored.

isTransient

public boolean isTransient()

Description copied from interface: StateHolder

If true, the Object implementing this interface must not participate in state saving or restoring.

Specified by:

isTransient in interface StateHolder

See Also:

StateHolder.isTransient()

setTransient

public void setTransient(boolean newTransientValue)

Description copied from interface: StateHolder

Denotes whether or not the Object implementing this interface must or must not participate in state saving or restoring.

Specified by:

setTransient in interface StateHolder

Parameters:

newTransientValue - boolean pass true if this Object will not participate in state saving or restoring, otherwise pass false.

See Also:

StateHolder.setTransient(boolean)

saveMap

private java.lang.Object saveMap(FacesContext context,
                                 java.util.Map<java.io.Serializable,java.lang.Object> map)

removeFromList

private java.lang.Object removeFromList(java.io.Serializable key,
                                        java.lang.Object value)

removeFromMap

private java.lang.Object removeFromMap(java.io.Serializable key,
                                       java.lang.String mapKey)

getTransient

public java.lang.Object getTransient(java.lang.Object key)

Description copied from interface: TransientStateHelper

Return the value currently associated with the specified key if any.

Specified by:

getTransient in interface TransientStateHelper

Parameters:

key - the key for which the value should be returned.

getTransient

public java.lang.Object getTransient(java.lang.Object key,
                                     java.lang.Object defaultValue)

Description copied from interface: TransientStateHelper

Performs the same logic as TransientStateHelper.getTransient(java.lang.Object) } but if no value is found, this will return the specified defaultValue

Specified by:

getTransient in interface TransientStateHelper

Parameters:

key - the key for which the value should be returned.

defaultValue - the value to return if no value is found in the call to get().

putTransient

public java.lang.Object putTransient(java.lang.Object key,
                                     java.lang.Object value)

Description copied from interface: TransientStateHelper

Return the previously stored value and store the specified key/value pair. This is intended to store data that would otherwise reside in an instance variable on the component.

Specified by:

putTransient in interface TransientStateHelper

Parameters:

key - the key for the value

value - the value

restoreTransientState

public void restoreTransientState(FacesContext context,
                                  java.lang.Object state)

Description copied from interface: TransientStateHolder

Restore the "transient state" using the object passed as state.

If the state argument is null clear any previous transient state if any and return.

Specified by:

restoreTransientState in interface TransientStateHolder

state - the object containing transient values

saveTransientState

public java.lang.Object saveTransientState(FacesContext context)

Description copied from interface: TransientStateHolder

Return the object containing related "transient states". that could be used later to restore the "transient state".

Specified by:

saveTransientState in interface TransientStateHolder

Returns:

object containing transient values