public interface TransientStateHelper extends 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.
Modifier and Type | Method and Description |
---|---|
Object |
getTransient(Object key)
Return the value currently associated with the specified |
Object |
getTransient(Object key,
Object defaultValue)
Performs the same logic as |
Object |
putTransient(Object key,
Object value)
Return the previously stored value and store the specified key/value pair. |
restoreTransientState, saveTransientState
Object getTransient(Object key)
Return the value currently associated with the specified key
if any.
key
- the key for which the value should be returned.Object getTransient(Object key, Object defaultValue)
Performs the same logic as getTransient(java.lang.Object)
} but if no value is found, this will return the specified
defaultValue
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()
.Object putTransient(Object key, Object value)
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.
key
- the key for the valuevalue
- the valueCopyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.