summaryrefslogtreecommitdiff
path: root/src/library/scala/collection/immutable/ListMap.scala
diff options
context:
space:
mode:
Diffstat (limited to 'src/library/scala/collection/immutable/ListMap.scala')
-rw-r--r--src/library/scala/collection/immutable/ListMap.scala150
1 files changed, 150 insertions, 0 deletions
diff --git a/src/library/scala/collection/immutable/ListMap.scala b/src/library/scala/collection/immutable/ListMap.scala
new file mode 100644
index 0000000000..b6c9989531
--- /dev/null
+++ b/src/library/scala/collection/immutable/ListMap.scala
@@ -0,0 +1,150 @@
+/* __ *\
+** ________ ___ / / ___ Scala API **
+** / __/ __// _ | / / / _ | (c) 2003-2005, LAMP/EPFL **
+** __\ \/ /__/ __ |/ /__/ __ | **
+** /____/\___/_/ |_/____/_/ | | **
+** |/ **
+** $Id$
+\* */
+
+package scala.collection.immutable;
+
+
+object ListMap {
+ def Empty[A, B] = new ListMap[A, B];
+}
+
+/** This class implements immutable maps using a list-based data
+ * structure. Instances of <code>ListMap</code> represent
+ * empty maps; they can be either created by calling the constructor
+ * directly, or by applying the function <code>ListMap.Empty</code>.
+ *
+ * @author Matthias Zenger
+ * @version 1.0, 09/07/2003
+ */
+[serializable]
+class ListMap[A, B] extends AnyRef with Map[A, B] {
+
+ /** This method returns a new ListMap instance mapping keys of the
+ * same type to values of type <code>C</code>.
+ */
+ def empty[C] = new ListMap[A, C];
+
+ /** Returns the number of mappings in this map.
+ *
+ * @return number of mappings.
+ */
+ def size: Int = 0;
+
+ /** Check if this map maps <code>key</code> to a value and return the
+ * value if it exists.
+ *
+ * @param key the key of the mapping of interest
+ * @return the value of the mapping, if it exists
+ */
+ def get(key: A): Option[B] = None;
+
+ /** This method allows one to create a new map with an
+ * additional mapping from <code>key</code>
+ * to <code>value</code>. If the map contains already a
+ * mapping for <code>key</code>, it will be overridden by this
+ * function.
+ */
+ def update(key: A, value: B): ListMap[A, B] = new Node(key, value);
+
+ /** This creates a new mapping without the given <code>key</code>.
+ * If the map does not contain a mapping for the given key, the
+ * method returns the same map.
+ */
+ def -(key: A): ListMap[A, B] = this;
+
+ /** This returns an iterator over key-value pairs.
+ */
+ def elements: Iterator[Pair[A, B]] = toList.elements;
+
+ /** This return a list of key-value pairs.
+ */
+ override def toList: List[Pair[A, B]] = Nil;
+
+ /** Compares two maps for equality.
+ * Two maps are equal iff they contain exactly the
+ * same key-value pairs.
+ */
+ override def equals(obj: Any): Boolean =
+ if (obj.isInstanceOf[scala.collection.Map[A, B]]) {
+ val that = obj.asInstanceOf[scala.collection.Map[A, B]];
+ if (size != that.size) false else toList.forall {
+ case Pair(key, value) => that.get(key) match {
+ case None => false;
+ case Some(v) => v == value;
+ }
+ };
+ } else
+ false;
+
+ override def hashCode(): Int = 0;
+
+ protected class Node(key: A, value: B) extends ListMap[A, B] {
+ /** Returns the number of mappings in this map.
+ *
+ * @return number of mappings.
+ */
+ override def size: Int = ListMap.this.size + 1;
+
+ /** Is this an empty map?
+ *
+ * @return true, iff the map is empty.
+ */
+ override def isEmpty: Boolean = false;
+
+ /** Retrieve the value which is associated with the given key. This
+ * method throws an exception if there is no mapping from the given
+ * key to a value.
+ *
+ * @param key the key
+ * @return the value associated with the given key.
+ */
+ override def apply(k: A): B = if (k == key) value else ListMap.this(k);
+
+ /** Check if this map maps <code>key</code> to a value and return the
+ * value if it exists.
+ *
+ * @param key the key of the mapping of interest
+ * @return the value of the mapping, if it exists
+ */
+ override def get(k: A): Option[B] =
+ if (k == key) Some(value) else ListMap.this.get(k);
+
+ /** This method allows one to create a new map with an
+ * additional mapping from <code>key</code>
+ * to <code>value</code>. If the map contains already a
+ * mapping for <code>key</code>, it will be overridden by this
+ * function.
+ */
+ override def update(k: A, v: B): ListMap[A, B] =
+ if (k == key) {
+ new ListMap.this.Node(k, v);
+ } else {
+ val tail = ListMap.this.update(k,v); new tail.Node(key, value)
+ }
+
+ /** This creates a new mapping without the given <code>key</code>.
+ * If the map does not contain a mapping for the given key, the
+ * method returns the same map.
+ */
+ override def -(k: A): ListMap[A, B] =
+ if (k == key)
+ ListMap.this
+ else {
+ val tail = ListMap.this - k; new tail.Node(key, value)
+ }
+
+ /** This return a list of key-value pairs.
+ */
+ override def toList: List[Pair[A, B]] = Pair(key, value) :: ListMap.this.toList;
+
+ override def hashCode(): Int =
+ (key.hashCode() ^ value.hashCode()) + ListMap.this.hashCode();
+ }
+}
+