Packagech.capi.data
Interfacepublic interface IMap
ImplementorsDictionnaryMap

Represents an object that maps keys to values.



Public Methods
 MethodDefined by
  
clear():void
Removes all of the mappings from this map.
IMap
  
containsKey(key:*):Boolean
Returns true if this map contains a mapping for the specified key.
IMap
  
containsValue(value:*):Boolean
Returns true if this map maps one or more keys to the specified value.
IMap
  
getValue(key:*):*
Retrieves the value mapped to the specified key or null if there is no mapping for the key.
IMap
  
isEmpty():Boolean
Returns true if the IMap contains no key-value mappings.
IMap
  
keys():Array
Retrieves all the keys contained into the IMap.
IMap
  
put(key:*, value:*):*
Associates the specified value with the specified key in the IMap.
IMap
  
putAll(source:IMap):void
Retrieves all the key/value from the source IMap and put them in the current IMap.
IMap
  
remove(key:*):*
Removes the mapping for a key from the IMap if it is present.
IMap
  
size():uint
Retrieves the number of key-value mappings into the IMap.
IMap
  
values():Array
Retrieves all the values contained into the IMap.
IMap
Method detail
clear()method
public function clear():void

Removes all of the mappings from this map.

containsKey()method 
public function containsKey(key:*):Boolean

Returns true if this map contains a mapping for the specified key.

Parameters
key:* — key The key.

Returns
Booleantrue if the specified key is contained into the IMap.
containsValue()method 
public function containsValue(value:*):Boolean

Returns true if this map maps one or more keys to the specified value.

Parameters
value:* — The value.

Returns
Booleantrue if the specified value is contained into the IMap.
getValue()method 
public function getValue(key:*):*

Retrieves the value mapped to the specified key or null if there is no mapping for the key.

Parameters
key:* — The key.

Returns
* — The object mapped to the specified key or null.
isEmpty()method 
public function isEmpty():Boolean

Returns true if the IMap contains no key-value mappings.

Returns
Booleantrue if there is no mapping.
keys()method 
public function keys():Array

Retrieves all the keys contained into the IMap.

Returns
Array — An Array containing all the keys.
put()method 
public function put(key:*, value:*):*

Associates the specified value with the specified key in the IMap.

Parameters
key:* — The key.
 
value:* — The value.

Returns
* — The previous value mapped to the key or null.
putAll()method 
public function putAll(source:IMap):void

Retrieves all the key/value from the source IMap and put them in the current IMap.

Parameters
source:IMap — The source IMap.
remove()method 
public function remove(key:*):*

Removes the mapping for a key from the IMap if it is present.

Parameters
key:* — The key to remove.

Returns
* — The mapped value for this key.
size()method 
public function size():uint

Retrieves the number of key-value mappings into the IMap.

Returns
uint — The number of key-value mappings.
values()method 
public function values():Array

Retrieves all the values contained into the IMap.

Returns
Array — An Array containing all the values.