-
- All Superinterfaces:
- TransientStateHolder
public interface TransientStateHelper extends TransientStateHolder
Define a
Map
-like contract that makes it easier for components to implementTransientStateHolder
. EachUIComponent
in the view will return an implementation of this interface from itsUIComponent.getTransientStateHelper()
method.The values retrieved or saved through
getTransient(java.lang.Object)
orputTransient(java.lang.Object, java.lang.Object)
will not be preserved between requests.- Since:
- 2.1
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description Object
getTransient(Object key)
Return the value currently associated with the specified
key
if any.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 specifieddefaultValue
Object
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 Detail
-
getTransient
Object getTransient(Object key)
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
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 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
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.
- Parameters:
key
- the key for the valuevalue
- the value- Since:
- 2.1
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/faces/component/transientstatehelper.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.