Interface StateHelper
-
- All Superinterfaces:
StateHolder
public interface StateHelper extends StateHolder
Define a
Map
-like contract that makes it easier for components to implementPartialStateHolder
. EachUIComponent
in the view will return an implementation of this interface from itsUIComponent.getStateHelper()
method.- Since:
- 2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
add(Serializable key, Object value)
Store the specifiedvalue
in aList
that is internal to theStateHelper
.Object
eval(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.Object
eval(Serializable key, Object defaultValue)
Performs the same logic aseval(java.io.Serializable)
} but if no value is found, this will return the specifieddefaultValue
Object
eval(Serializable key, Supplier<Object> defaultValueSupplier)
Performs the same logic aseval(java.io.Serializable)
} but if no value is found, this will return the return-value of thedefaultValueSupplier
Object
get(Serializable key)
Return the value currently associated with the specifiedkey
if any.Object
put(Serializable key, Object value)
Return the previously stored value and store the specified key/value pair.Object
put(Serializable key, String mapKey, Object value)
Store the specifiedmapKey
/value
in aMap
that is internal to the helper, and return the previously stored value.Object
remove(Serializable key)
Remove the key/value pair from the helper, returning the value previously stored under this key.Object
remove(Serializable key, Object valueOrKey)
Remove a value from the inner data structure.-
Methods inherited from interface jakarta.faces.component.StateHolder
isTransient, restoreState, saveState, setTransient
-
-
-
-
Method Detail
-
put
Object put(Serializable 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- Returns:
- the previously stored value
- Since:
- 2.0
-
remove
Object remove(Serializable key)
Remove the key/value pair from the helper, returning the value previously stored under this key.
- Parameters:
key
- the key to remove- Returns:
- the removed value.
- Since:
- 2.0
-
put
Object put(Serializable key, String mapKey, Object value)
Store the specified
mapKey
/value
in aMap
that is internal to the helper, and return the previously stored value. TheMap
will then be associated withkey
.It's important to note for delta tracking that any modifications to the internal
Map
be made through this method orremove(java.io.Serializable, Object)
.- Parameters:
key
- the key of the map itselfmapKey
- the key within the internal mapvalue
- the value for the key in the internal map- Returns:
- the value.
- Since:
- 2.0
-
get
Object get(Serializable key)
Return the value currently associated with the specified
key
if any.- Parameters:
key
- the key for which the value should be returned.- Returns:
- the value.
- Since:
- 2.0
-
eval
Object eval(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.
- Parameters:
key
- the name of the value in the internal map, or the name of a value expression in the components value expression collection.- Returns:
- the evaluated value.
- Since:
- 2.0
-
eval
Object eval(Serializable key, Object defaultValue)
Performs the same logic as
eval(java.io.Serializable)
} 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 toeval()
.- Returns:
- the evaluated value.
- Since:
- 2.0
-
eval
Object eval(Serializable key, Supplier<Object> defaultValueSupplier)
Performs the same logic as
eval(java.io.Serializable)
} but if no value is found, this will return the return-value of thedefaultValueSupplier
- Parameters:
key
- the key for which the value should be returned.defaultValueSupplier
- the supplier used to evaluate the default value if no value is found in the call toeval()
.- Returns:
- the evaluated value.
- Since:
- 4.0
-
add
void add(Serializable key, Object value)
Store the specified
value
in aList
that is internal to theStateHelper
.It's important to note for delta tracking that any modifications to the internal
List
be made through this method orremove(java.io.Serializable, Object)
.- Parameters:
key
- the key for which the value should be returned.value
- the value to add- Since:
- 2.0
-
remove
Object remove(Serializable key, Object valueOrKey)
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 aMap
, remove and return the value under the key given by thevalueOrKey
argument. If the value is aCollection
, simply remove the value given by the argumentvalueOrKey
and return null.- Parameters:
key
- the key of in the inner data structure whose value is aCollection
orMap
valueOrKey
- the value or key to be removed.- Returns:
- the removed value.
-
-