public interface StateHelper extends StateHolder
Define a Map
-like contract
that makes it easier for components to implement PartialStateHolder
. Each UIComponent
in the view will
return an implementation of this interface from its UIComponent.getStateHelper()
method.
Modifier and Type | Method and Description |
---|---|
void |
add(Serializable key,
Object value)
Store the specified
|
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 as |
Object |
get(Serializable key)
Return the value currently
associated with the specified |
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 specified
|
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. |
isTransient, restoreState, saveState, setTransient
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.
key
- the key for the valuevalue
- the valueObject remove(Serializable key)
Remove the key/value pair from the helper, returning the value previously stored under this key.
key
- the key to removeObject put(Serializable key, String mapKey, Object value)
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 remove(java.io.Serializable,
Object)
.
key
- the key of the map itselfmapKey
- the key within the internal mapvalue
- the value for the key in the internal mapObject get(Serializable key)
Return the value currently
associated with the specified key
if any.
key
- the key for which the value should be returned.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.
key
- the name of the value in the internal map, or the name
of a value expression in the components value expression
collection.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 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 eval()
.void add(Serializable key, Object value)
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 remove(java.io.Serializable, Object)
.
key
- the key for which the value should be returned.value
- the value to addObject 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 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.
key
- the key of in the inner data structure whose value is
a Collection
or Map
valueOrKey
- the value or key to be removed.Copyright © 1996-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.