Generated by JsDoc Toolkit 2.3.2 on Sun Jun 13 2010 17:28:18 GMT+0200 (CEST)
HTML template: Codeview

Class calitha.collections.IMap

An object that maps keys to values.

It is based on the Java Map interface.
Defined in: IMap.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Removes all of the mappings from this map.
 
Returns true if this map contains a mapping for the specified key.
 
Returns true if this map maps one or more keys to the specified value.
 
Returns a Set view of the mappings contained in this map.
 
equals(o)
Compares the specified object with this map for equality.
 
get(key)
Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
 
Returns the hash code value for this map.
 
Returns true if this map contains no key-value mappings.
 
Returns a Set view of the keys contained in this map.
 
put(key, value)
Associates the specified value with the specified key in this map.
 
putAll(m)
Copies all of the mappings from the specified map to this map
 
remove(key)
Removes the mapping for a key from this map if it is present.
 
size()
Returns the number of key-value mappings in this map.
 
Returns a Collection view of the values contained in this map.
Class Detail
calitha.collections.IMap()
Method Detail
clear()
Removes all of the mappings from this map.
{Boolean} containsKey(key)
Returns true if this map contains a mapping for the specified key.
Parameters:
{Object} key
key whose presence in this map is to be tested
Returns:
{Boolean} true if this map contains a mapping for the specified key
{Boolean} containsValue(value)
Returns true if this map maps one or more keys to the specified value.
Parameters:
{Object} value
whose presence in this map is to be tested
Returns:
{Boolean} true if this map maps one or more keys to the specified value
Returns a Set view of the mappings contained in this map.
Returns:
{calitha.collections.ICollection} <calitha.collections.imap.IEntry> a set view of the mappings contained in this map
{Boolean} equals(o)
Compares the specified object with this map for equality.
Parameters:
{Object} o
Returns:
{Boolean} true if the specified object is equal to this map
{Object} get(key)
Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
Parameters:
{Object} key
the key whose associated value is to be returned
Returns:
{Object} the value to which the specified key is mapped, or null if this map contains no mapping for the key
{Number} hashCode()
Returns the hash code value for this map.
Returns:
{Number} the hash code value for this map
{Boolean} isEmpty()
Returns true if this map contains no key-value mappings.
Returns:
{Boolean} true if this map contains no key-value mappings
Returns a Set view of the keys contained in this map.
Returns:
{calitha.collections.ICollection} <Object> a set view of the keys contained in this map
{Object} put(key, value)
Associates the specified value with the specified key in this map.
Parameters:
{Object} key
key with which the specified value is to be associated
{Object} value
value to be associated with the specified key
Returns:
{Object} the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)
putAll(m)
Copies all of the mappings from the specified map to this map
Parameters:
{calitha.collections.IMap} m
mappings to be stored in this map
{Object} remove(key)
Removes the mapping for a key from this map if it is present.
Parameters:
{Object} key
key whose mapping is to be removed from the map
Returns:
{Object} the previous value associated with key, or null if there was no mapping for key.
{Number} size()
Returns the number of key-value mappings in this map.
Returns:
{Number} the number of key-value mappings in this map
Returns a Collection view of the values contained in this map.
Returns:
{calitha.collections.ICollection} <Object> a collection view of the values contained in this map