org.apache.pivot.wtk
Class Component.UserDataDictionary

java.lang.Object
  extended by org.apache.pivot.wtk.Component.UserDataDictionary
All Implemented Interfaces:
Iterable<String>, Dictionary<String,Object>
Enclosing class:
Component

public final class Component.UserDataDictionary
extends Object
implements Dictionary<String,Object>, Iterable<String>

User data dictionary implementation.


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.pivot.collections.Dictionary
Dictionary.Pair<K,V>
 
Method Summary
 boolean containsKey(String key)
          Tests the existence of a key in the dictionary.
 Object get(String key)
          Retrieves the value for the given key.
 Iterator<String> iterator()
           
 Object put(String key, Object value)
          Sets the value of the given key, creating a new entry or replacing the existing value.
 Object remove(String key)
          Removes a key/value pair from the map.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

get

public Object get(String key)
Description copied from interface: Dictionary
Retrieves the value for the given key.

Specified by:
get in interface Dictionary<String,Object>
Parameters:
key - The key whose value is to be returned.
Returns:
The value corresponding to key, or null if the key does not exist. Will also return null if the key refers to a null value. Use containsKey() to distinguish between these two cases.

put

public Object put(String key,
                  Object value)
Description copied from interface: Dictionary
Sets the value of the given key, creating a new entry or replacing the existing value.

Specified by:
put in interface Dictionary<String,Object>
Parameters:
key - The key whose value is to be set.
value - The value to be associated with the given key.
Returns:
The value previously associated with the key.

remove

public Object remove(String key)
Description copied from interface: Dictionary
Removes a key/value pair from the map.

Specified by:
remove in interface Dictionary<String,Object>
Parameters:
key - The key whose mapping is to be removed.
Returns:
The value that was removed.

containsKey

public boolean containsKey(String key)
Description copied from interface: Dictionary
Tests the existence of a key in the dictionary.

Specified by:
containsKey in interface Dictionary<String,Object>
Parameters:
key - The key whose presence in the dictionary is to be tested.
Returns:
true if the key exists in the dictionary; false, otherwise.

iterator

public Iterator<String> iterator()
Specified by:
iterator in interface Iterable<String>