in scala/collection/immutable
trait Map

trait Map[A,B]()
extends Object
with ScalaObject
with Map[A,B]
Implementing classes or objects:
class TreeMap[A,B](view: (A) => Ordered[A])
class ListMap[A,B]()

This trait extends the Map interface of collections that unambiguously map keys to values (i.e. a key is mapped to at least one value). This trait defines the interface for functional map implementations relying on immutable data structures. Concrete map implementations have to provide functionality for the abstract methods in scala.collection.Map as well as for factory, update, and -.
Author:
Matthias Zenger, Erik Stenman
Version:
1.1, 22/03/2004

Method Summary
  def +(key: A): MapTo
     This method defines syntactic sugar for adding a mapping.
abstract def -(key: A): Map[A,B]
     This creates a new mapping without the given key.
abstract def empty[C]: Map[A,C]
     This method returns a new map instance of the same class mapping keys of the same type to values of type C.
  def excl(keys: A*): Map[A,B]
     This method will return a map where all the mappings for the given sequence of keys are removed from the map.
  def excl(keys: Iterable[A]): Map[A,B]
     This method removes all the mappings for keys provided by an iterator over the elements of the keys object.
  def filter(p: (A,B) => Boolean): Map[A,B]
     This method removes all the mappings for which the predicate p returns false.
override def hashCode(): Int
  def incl(mappings: Tuple2[A,B]*): Map[A,B]
     incl can be used to add many mappings at the same time to the map.
  def incl(map: Iterable[Tuple2[A,B]]): Map[A,B]
     incl can be used to add many mappings at the same time to the map.
  def map[C](f: (A,B) => C): Map[A,C]
     This function transforms all the values of mappings contained in this map with function f.
  def mappingToString(p: Tuple2[A,B]): String
     This method controls how a mapping is represented in the string representation provided by method toString.
override def toString(): String
     Returns a string representation of this map which shows all the mappings.
abstract def update(key: A, value: B): Map[A,B]
     This method allows one to create a new map with an additional mapping from key to value.

Methods inherited from java/lang/Object-class
clone, eq, finalize, getClass, notify, notifyAll, synchronized, wait, wait, wait

Methods inherited from scala/Any-class
!=, ==, asInstanceOf, isInstanceOf, match

Methods inherited from scala/Iterable-class
/:, :\, elements, exists, find, foldLeft, foldRight, forall, foreach, sameElements

Methods inherited from scala/collection/Map-class
apply, contains, equals, exists, forall, foreach, get, isDefinedAt, isEmpty, keys, size, toList, values

Class Summary
  class MapTo(key: A)

Method Detail

empty

  abstract def empty[C]: Map[A,C]
This method returns a new map instance of the same class mapping keys of the same type to values of type C.

update

  abstract def update(key: A, value: B): Map[A,B]
This method allows one to create a new map with an additional mapping from key to value. If the map contains already a mapping for key, it will be overridden by this function.

-

  abstract def -(key: A): Map[A,B]
This creates a new mapping without the given key. If the map does not contain a mapping for the given key, the method returns the same map.

+

  def +(key: A): MapTo
This method defines syntactic sugar for adding a mapping. It is typically used in the following way:
  map + key -> value;
  

incl

  def incl(mappings: Tuple2[A,B]*): Map[A,B]
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.

incl

  def incl(map: Iterable[Tuple2[A,B]]): Map[A,B]
incl can be used to add many mappings at the same time to the map. The method assumes that each mapping is represented by an Iterator over Pair objects who's first component denotes the key, and who's second component refers to the value.

excl

  def excl(keys: A*): Map[A,B]
This method will return a map where all the mappings for the given sequence of keys are removed from the map.

excl

  def excl(keys: Iterable[A]): Map[A,B]
This method removes all the mappings for keys provided by an iterator over the elements of the keys object.

map

  def map[C](f: (A,B) => C): Map[A,C]
This function transforms all the values of mappings contained in this map with function f.

filter

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

toString

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

hashCode

  override def hashCode(): Int

mappingToString

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