nsIDictionary in Firefox 2.0

Implemented by

@mozilla.org/dictionary;1

 A simple mutable table of objects, accessed by key.

[scriptable, uuid(1dd0cb45-aea3-4a52-8b29-01429a542863)]

Methods

 Delete all key-value pairs from the dictionary.

void clear()

 Delete the indicated key-value pair.

 @param key       The key indicating the pair to be removed.
 @return          The removed value. If the key doesn't exist,
                  NS_ERROR_FAILURE will be returned.

nsISupports deleteValue(in string key)

 Retrieve all keys in the dictionary.

 @return          array of all keys, unsorted.

void getKeys(out PRUint32 count, [array, size_is(count), retval] out string keys)

 Find the value indicated by the key.

 @param key       The lookup key indicating the value.
 @return          Value indicated by key. If the key doesn't exist,
                  NS_ERROR_FAILURE will be returned.

nsISupports getValue(in string key)

 Check if a given key is present in the dictionary.

 @param key       Key to check for
 @return          true if present, false if absent.

boolean hasKey(in string key)

 Add the key-value pair to the dictionary.
 If the key is already present, replace the old value
 with the new.

 @param key       The key by which the value can be accessed
 @param value     The value to be stored.

void setValue(in string key, in nsISupports value)