Interface TransientStateHelper
- All Superinterfaces:
TransientStateHolder
Define a Map
-like contract
that makes it easier for components to implement TransientStateHolder
. Each UIComponent
in the view will
return an implementation of this interface from its UIComponent.getTransientStateHelper()
method.
The values retrieved or saved through getTransient(java.lang.Object)
or putTransient(java.lang.Object, java.lang.Object)
will not be
preserved between requests.
- Since:
- 2.1
-
Method Summary
Modifier and TypeMethodDescriptiongetTransient
(Object key) Return the value currently associated with the specifiedkey
if any.getTransient
(Object key, Object defaultValue) Performs the same logic asgetTransient(java.lang.Object)
} but if no value is found, this will return the specifieddefaultValue
putTransient
(Object key, Object value) Return the previously stored value and store the specified key/value pair.Methods inherited from interface javax.faces.component.TransientStateHolder
restoreTransientState, saveTransientState
-
Method Details
-
getTransient
Return the value currently associated with the specified
key
if any.- Parameters:
key
- the key for which the value should be returned.- Since:
- 2.1
-
getTransient
Performs the same logic as
getTransient(java.lang.Object)
} but if no value is found, this will return the specifieddefaultValue
- Parameters:
key
- the key for which the value should be returned.defaultValue
- the value to return if no value is found in the call toget()
.- Since:
- 2.1
-
putTransient
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.
- Parameters:
key
- the key for the valuevalue
- the value- Since:
- 2.1
-