| Package | com.elad.framework.utils.collections |
| Interface | public interface IMap extends flash.events.IEventDispatcher |
| Implementors | HashMapCollection |
IMap is the contract for the HashMapCollection. The class extentiate the
IEventDispatcher interface to insure the creating of all the classes to dispach change events.
| Property | Defined by | ||
|---|---|---|---|
| addAll : HashMapCollection
[write-only]
Copies all of the mappings from the specified map to this map
These mappings will be replace for any mappings that this map had
for the keys currently in the specified map.
| IMap | ||
| isEmpty : Boolean [read-only]
| IMap | ||
| keySet : Array [read-only]
Returns an array collection of the keys contained in this map.
| IMap | ||
| length : int [read-only]
Method to check the size of the HashMap Collection.
| IMap | ||
| Method | Defined by | ||
|---|---|---|---|
|
addItem(key:*, value:*):void
Add a pair to the collection.
| IMap | ||
|
clone():Object
Clone the map, the keys and values themselves are not cloned.
| IMap | ||
|
compare(key:*, value:*):Boolean
Compare specified key with the map value for equality.
| IMap | ||
|
containsKey(key:*):Boolean
Check if the collection contains a key.
| IMap | ||
|
containsValue(value:*):Boolean
Check if collection contain value.
| IMap | ||
|
getItemKey(value:*):String
Return the item key based on it's value.
| IMap | ||
|
getItemsValues():Array
Method to retrieve the values.
| IMap | ||
|
getItemValue(key:*):*
Retrieve an item value based on its key.
| IMap | ||
|
removeAll():void
| IMap | ||
|
removeItemAt(key:*):void
Remove an item based on key.
| IMap | ||
|
reset():void
| IMap | ||
|
toString():String
Method to convert the map into a string representation consists of a list of key-value.
| IMap | ||
| Event | Summary | Defined by | ||
|---|---|---|---|---|
| Dispatched when the Map has been updated in some way. | IMap | |||
| addAll | property |
addAll:HashMapCollection [write-only]Copies all of the mappings from the specified map to this map These mappings will be replace for any mappings that this map had for the keys currently in the specified map.
Implementation public function set addAll(value:HashMapCollection):void
| isEmpty | property |
isEmpty:Boolean [read-only]Implementation
public function get isEmpty():Boolean
| keySet | property |
keySet:Array [read-only]Returns an array collection of the keys contained in this map.
Implementation public function get keySet():Array
| length | property |
length:int [read-only]Method to check the size of the HashMap Collection.
Implementation public function get length():int
| addItem | () | method |
public function addItem(key:*, value:*):voidAdd a pair to the collection.
Parameterskey:* — key.
|
|
value:* — value
|
| clone | () | method |
public function clone():ObjectClone the map, the keys and values themselves are not cloned.
ReturnsObject — Returns a shallow copy.
|
| compare | () | method |
public function compare(key:*, value:*):BooleanCompare specified key with the map value for equality.
Parameterskey:* |
|
value:* |
Boolean |
| containsKey | () | method |
public function containsKey(key:*):BooleanCheck if the collection contains a key.
Parameterskey:* — collection key.
|
Boolean — true|false
|
| containsValue | () | method |
public function containsValue(value:*):BooleanCheck if collection contain value.
Parametersvalue:* — value from any type.
|
Boolean — true|false
|
| getItemKey | () | method |
public function getItemKey(value:*):StringReturn the item key based on it's value.
Parametersvalue:* — The item value.
|
String — The item Key.
|
| getItemsValues | () | method |
public function getItemsValues():ArrayMethod to retrieve the values.
ReturnsArray — An array with all the values in the map.
|
| getItemValue | () | method |
public function getItemValue(key:*):*Retrieve an item value based on its key.
Parameterskey:* — Key can be any type. Usually string.
|
* — The value.
|
| removeAll | () | method |
public function removeAll():void
| removeItemAt | () | method |
public function removeItemAt(key:*):voidRemove an item based on key.
Parameterskey:* — The collection key.
|
| reset | () | method |
public function reset():void
| toString | () | method |
public function toString():StringMethod to convert the map into a string representation consists of a list of key-value.
ReturnsString — Returns a string representation of this map. The string representation consists of a list of key-value.
|
| collectionChange | event |