Determinates the internal build class used in the createCollection() method to create a new collection to register all values with a new key. The class must implements the Collection interface and by default the ArrayCollection class is used.

Creates a new MultiValueMap instance.

Example :

         import system.data.maps.MultiValueMap ;
         var map:MultiValueMap = new MultiValueMap() ;
         

Removes all elements in this map.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put( "key1" , "hello"   ) ;
         map.put( "key2" , "bonjour" ) ;
         
         map.clear() ;
         
         trace( map ) ; // {}
         

Returns a shallow copy of this object.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put("keyA" , "itemA_1" ) ;
         map.put("keyA" , "itemA_2" ) ;
         map.put("keyB" , "itemB_2" ) ;
         
         var clone:MultiValueMap = map.clone() ;
         trace( clone ) ;
         

Checks whether the map contains the key specified.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put( "key1" , "hello world" ) ;
         
         trace( map.containsKey( "key1" ) ) ; // true
         trace( map.containsKey( "key2" ) ) ; // false
         

Parameters

Checks whether the map contains the value specified.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put( "key1" , "hello"   ) ;
         map.put( "key2" , "bonjour" ) ;
         
         trace( map.containsValue( "hello"       ) ) ; // true
         trace( map.containsValue( "bonjour"     ) ) ; // true
         trace( map.containsValue( "buenos dias" ) ) ; // false
         

Parameters

Checks whether the map contains the value specified or at the specified key contains the value.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put( "key1" , "hello"   ) ;
         map.put( "key2" , "bonjour" ) ;
         
         trace( map.containsValueByKey( "key1" , "hello"   ) ) ; // true
         trace( map.containsValueByKey( "key1" , "bonjour" ) ) ; // false
         
         trace( map.containsValueByKey( "key2" , "hello"       ) ) ; // false
         trace( map.containsValueByKey( "key2" , "bonjour"     ) ) ; // true
         

Parameters

Creates a new instance of the map value Collection container. This method can be overridden to use your own collection type.

Gets the collection mapped to the specified key.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put( "key1" , "hello"   ) ;
         map.put( "key2" , "bonjour" ) ;
         
         trace( map.get( "key1"  ) ) ; // {hello}
         trace( map.get( "key2"  ) ) ; // {bonjour}
         trace( map.get( "key3"  ) ) ; // undefined
         

Parameters

Gets the collection mapped to the specified key.

This method is a convenience method to typecast the result of get(key).

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put( "key1" , "hello"   ) ;
         map.put( "key2" , "bonjour" ) ;
         
         trace( map.getCollection( "key1"  ) ) ; // {hello}
         trace( map.getCollection( "key2"  ) ) ; // {bonjour}
         trace( map.getCollection( "key3"  ) ) ; // null
         

Parameters

Returns an Array containing the combination of all keys in the Map.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put( "key1" , "hello"   ) ;
         map.put( "key2" , "bonjour" ) ;
         
         trace( map.getKeys() ) ; // key1,key2
         

Returns an Array containing the combination of values from all keys.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put( "key1" , "A1"   ) ;
         map.put( "key2" , "B1" ) ;
         map.put( "key2" , "B2" ) ;
         map.put( "key3" , "C1" ) ;
         
         trace( map.getValues() ) ; // no order if the internal Map is a HashMap (default)
         

Returns whether this object contains any mappings.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         trace( map.isEmpty() ) ;  // true
         
         map.put( "key" , "value"   ) ;
         
         trace( map.isEmpty() ) ; // false
         

Returns the Iterator representation of the object.

Gets an Iterator for the collection mapped to the specified key.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put("key1" , "value1") ;
         map.put("key1" , "value2") ;
         map.put("key2" , "value3") ;
         
         trace( map.iteratorByKey( "key1" ) ) ; // [object ArrayIterator]
         trace( map.iteratorByKey( "key3" ) ) ; // null
         

Parameters

Gets an iterator for the map to iterate keys.

Adds the value to the collection associated with the specified key.

Unlike a normal Map the previous value is not replaced. Instead the new value is added to the collection stored against the key.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put("keyA" , "itemA_1" ) ;
         map.put("keyA" , "itemA_2" ) ;
         
         map.put("keyB" , "itemB_2" ) ;
         
         trace( map ) ; // {keyB:{itemB_2},keyA:{itemA_1,itemA_2}}
         

Parameters

Override superclass to ensure that MultiMap instances are correctly handled.

If you call this method with a normal map, each entry is added using put(key:value:. If you call this method with a multi map, each entry is added using putCollection( key: co:Collection ).

Example :

         import system.data.collections.ArrayCollection ;
         
         import system.data.maps.ArrayMap ;
         import system.data.maps.MultiValueMap ;
         
         var am1:ArrayMap = new ArrayMap( [ "key1" , "key2" ] , ["value1" , "value2" ] ) ;
         var am2:ArrayMap = new ArrayMap( [ "key1" ]          , [ new ArrayCollection( [ "value3" ] ) ] ) ;
         
         var mm:MultiValueMap = new MultiValueMap() ;
         
         mm.putAll( am1 ) ; // {key2:{value2},key1:{value1}}
         
         trace( mm ) ;
         
         mm.putAll( am2 ) ; // {key2:{value2},key1:{value1,value3}}
         
         trace( mm ) ;
         

Parameters

Adds a collection of values to the collection associated with the specified key.

Example :

         import system.data.collections.ArrayCollection ;
         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.putCollection( "key1" , new ArrayCollection(["value1", "value2"])) ;
         map.putCollection( "key1" , new ArrayCollection(["value3", "value4"])) ;
         map.putCollection( "key2" , new ArrayCollection(["value5"])) ;
         
         trace( map ) ; // {key2:{value5},key1:{value1,value2,value3,value4}}
         

Parameters

Removes a specific value from map with a specific key.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put("key1" , "value1") ;
         map.put("key1" , "value2") ;
         map.put("key2" , "value3") ;
         
         trace( map.remove("key1") ) ; // {value1,value2}
         

Parameters

Removes a specific value from all the map.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put("key1" , "value1") ;
         map.put("key1" , "value2") ;
         map.put("key2" , "value3") ;
         
         trace( map.removeByKey("key1" , "value1" ) ) ; // true
         trace( map.removeByKey("key1" , "value5" ) ) ; // false
         
         trace( map ) ; // {key2:{value3},key1:{value2}}
         

Parameters

Returns the size of the collection mapped to the specified key.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         trace( map.size() ) ;  // 0
         
         map.put( "key1" , "value1" ) ;
         map.put( "key1" , "value2" ) ;
         map.put( "key2" , "value3" ) ;
         
         trace( map.size() ) ; // 2
         

Returns the source code string representation of the object.

Parameters

Returns the string representation of this instance.

Returns the total size of the map by counting all the values.

Example :

         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         trace( map.totalSize() ) ;  // 0
         
         map.put( "key1" , "value1" ) ;
         map.put( "key1" , "value2" ) ;
         map.put( "key2" , "value3" ) ;
         
         trace( map.totalSize() ) ; // 3
         

Returns the iterator representation of all Collections register in the MultiValueMap, all collections represents a key.

Example :

         import system.data.Iterator ;
         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put( "key1" , "A1"   ) ;
         map.put( "key2" , "B1" ) ;
         map.put( "key2" , "B2" ) ;
         map.put( "key3" , "C1" ) ;
         
         var it:Iterator = map.valueIterator() ;
         
         trace( it ) ;
         
         while( it.hasNext() )
         {
             trace( it.next() ) ;
         }
         

Returns a Collection of all values in the MultiValueMap.

Example :

         import system.data.Collection ;
         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put( "key1" , "A1"   ) ;
         map.put( "key2" , "B1" ) ;
         map.put( "key2" , "B2" ) ;
         map.put( "key3" , "C1" ) ;
         
         var c:Collection = map.values() ;
         
         trace( c ) ;
         

Returns an Iterator representation of all values in the MultiValueMap.

         import system.data.Iterator ;
         import system.data.maps.MultiValueMap ;
         
         var map:MultiValueMap = new MultiValueMap() ;
         
         map.put( "key1" , "A1"   ) ;
         map.put( "key2" , "B1" ) ;
         map.put( "key2" , "B2" ) ;
         map.put( "key3" , "C1" ) ;
         
         var it:Iterator = map.valuesIterator() ;
         
         trace( it ) ;
         
         while( it.hasNext() )
         {
             trace( it.next() ) ;
         }