oracle.cabo.ui.collection
Interface ContextMap

All Known Implementing Classes:

IncludeContextMap, RootContextMap, DictionaryContextMap, ContextMapProxy

public interface ContextMap

Map-like object for storing context-based information. Since the context is passed in to the get and keys methods, ContextMaps that delegate all or some of their properties through the RenderingContext. The MutableUINode class uses a ContextMap to store its named children, for this very reason, as it enables developers to data bind the named children nodes.

See Also:

BaseMutableUINode.setNamedChildMap(oracle.cabo.ui.collection.ContextMap)

Method Summary

java.lang.Object	get(RenderingContext context, java.lang.Object key) Returns the Object stored under the key, returning null if no Object with that key exists.
java.util.Enumeration	keys(RenderingContext context) Returns an Enumeration of all of the keys in the ContextMap given the specified context.
void	set(java.lang.Object key, java.lang.Object value) Stores the value in the map, under the key.

Method Detail

get

public java.lang.Object get(RenderingContext context,
                            java.lang.Object key)

Returns the Object stored under the key, returning null if no Object with that key exists.

Parameters:

context - RenderingContext to use to fulfill this request

key - key used to retrieve the value

Returns:

The value stored under this key, or null if no value is found.

Throws:

java.lang.IllegalArgumentException - if the key is null

set

public void set(java.lang.Object key,
                java.lang.Object value)

Stores the value in the map, under the key.

As the RenderingContext is not passed to this function, sets do not have the same databinding capabilities that gets do.

Parameters:

key - key used to set the value

value - The new value to set

Throws:

java.lang.IllegalArgumentException - if either the key or value is null.

keys

public java.util.Enumeration keys(RenderingContext context)

Returns an Enumeration of all of the keys in the ContextMap given the specified context.

The entire contents of the ContextMap can be retrieved by calling ContextMap.get for each of the keys in the enumeration.

Parameters:

RenderingContext - context Context used to determine the set of keys.

Returns:

The Enumeration of keys in the RenderingContext