in scala.collection.mutable
class Map

mixin abstract class Map [ A , B ]
extends java.lang.Object
with scala.collection.Map[A,B]
with scala.collection.mutable.Scriptable[scala.collection.mutable.Message[scala.Tuple2[A,B]]]
with scala.ScalaObject
This class represents mutable maps. Concrete map implementations just have to provide functionality for the abstract methods in scala.collection.Map as well as for update, and remove.
author:
Matthias Zenger
version:
1.1, 09/05/2004

Class Summary
class MapTo



Def Summary
def ++= ( it : scala.Iterator[scala.Tuple2[A,B]] ) : scala.Unit
This method adds all the mappings provided by an iterator of parameter map to the map.
def ++= ( map : scala.Iterable[scala.Tuple2[A,B]] ) : scala.Unit
This method adds all the mappings provided by an iterator of parameter map to the map.
def += ( key : A ) : Map.this.MapTo
This method defines syntactic sugar for adding or modifying mappings. It is typically used in the following way:
     map += key -> value;
     

def --= ( it : scala.Iterator[A] ) : scala.Unit
This method removes all the mappings for keys provided by an iterator over the elements of the keys object.
def --= ( keys : scala.Iterable[A] ) : scala.Unit
This method removes all the mappings for keys provided by an iterator over the elements of the keys object.
def -= ( key : A ) : scala.Unit
This method removes a mapping from the given key. If the map does not contain a mapping for the given key, the method does nothing.
def << ( cmd : scala.collection.mutable.Message[scala.Tuple2[A,B]] ) : scala.Unit
Send a message to this scriptable object.
def clear : scala.Unit
Removes all mappings from the map. After this operation is completed, the map is empty.
override def clone : scala.collection.mutable.Map[A,B]
Return a clone of this map.
def excl ( keys : A* ) : scala.Unit
This method will remove all the mappings for the given sequence of keys from the map.
def filter ( p : (A, B) => scala.Boolean ) : scala.Unit
This method removes all the mappings for which the predicate p returns false.
override def hashCode : scala.Int
The hashCode method always yields an error, since it is not safe to use mutable maps as keys in hash tables.
def incl ( mappings : scala.Tuple2[A,B]* ) : scala.Unit
incl can be used to add many mappings at the same time to the map. The method assumes that a mapping is represented by a Pair object who's first component denotes the key, and who's second component refers to the value.
def map ( f : (A, B) => B ) : scala.Unit
This function transforms all the values of mappings contained in this map with function f.
def mappingToString ( p : scala.Tuple2[A,B] ) : java.lang.String
This method controls how a mapping is represented in the string representation provided by method toString.
override def toString : java.lang.String
Returns a string representation of this map which shows all the mappings.
def update ( key : A , value : B ) : scala.Unit
This method allows one to add a new mapping from key to value to the map. If the map already contains a mapping for key, it will be overridden by this function.


Def Detail
def ++= ( it : scala.Iterator[scala.Tuple2[A,B]] ) : scala.Unit
This method adds all the mappings provided by an iterator of parameter map to the map.
param:
it

def ++= ( map : scala.Iterable[scala.Tuple2[A,B]] ) : scala.Unit
This method adds all the mappings provided by an iterator of parameter map to the map.
param:
map

def += ( key : A ) : Map.this.MapTo
This method defines syntactic sugar for adding or modifying mappings. It is typically used in the following way:
     map += key -> value;
     

def --= ( it : scala.Iterator[A] ) : scala.Unit
This method removes all the mappings for keys provided by an iterator over the elements of the keys object.
param:
it

def --= ( keys : scala.Iterable[A] ) : scala.Unit
This method removes all the mappings for keys provided by an iterator over the elements of the keys object.
param:
keys

def -= ( key : A ) : scala.Unit
This method removes a mapping from the given key. If the map does not contain a mapping for the given key, the method does nothing.

def << ( cmd : scala.collection.mutable.Message[scala.Tuple2[A,B]] ) : scala.Unit
Send a message to this scriptable object.
param:
cmd the message to send.

def clear : scala.Unit
Removes all mappings from the map. After this operation is completed, the map is empty.

override def clone : scala.collection.mutable.Map[A,B]
Return a clone of this map.
return:
an map with the same elements.

def excl ( keys : A* ) : scala.Unit
This method will remove all the mappings for the given sequence of keys from the map.
param:
keys

def filter ( p : (A, B) => scala.Boolean ) : scala.Unit
This method removes all the mappings for which the predicate p returns false.
param:
p

override def hashCode : scala.Int
The hashCode method always yields an error, since it is not safe to use mutable maps as keys in hash tables.
return:
never.

def incl ( mappings : scala.Tuple2[A,B]* ) : scala.Unit
incl can be used to add many mappings at the same time to the map. The method assumes that a mapping is represented by a Pair object who's first component denotes the key, and who's second component refers to the value.
param:
mappings

def map ( f : (A, B) => B ) : scala.Unit
This function transforms all the values of mappings contained in this map with function f.
param:
f

def mappingToString ( p : scala.Tuple2[A,B] ) : java.lang.String
This method controls how a mapping is represented in the string representation provided by method toString.
param:
p

override def toString : java.lang.String
Returns a string representation of this map which shows all the mappings.

def update ( key : A , value : B ) : scala.Unit
This method allows one to add a new mapping from key to value to the map. If the map already contains a mapping for key, it will be overridden by this function.
param:
key
param:
value