diff options
author | Aleksandar Pokopec <aleksandar.prokopec@epfl.ch> | 2010-04-09 21:00:41 +0000 |
---|---|---|
committer | Aleksandar Pokopec <aleksandar.prokopec@epfl.ch> | 2010-04-09 21:00:41 +0000 |
commit | b1307080fc2fa56602e91524d65a201d9d7974e0 (patch) | |
tree | 4620e154521743ed5a1e0395cd58f6267a7ef8ed | |
parent | 83d8f0b8f832453144aff6588100de4d24069315 (diff) | |
download | scala-b1307080fc2fa56602e91524d65a201d9d7974e0.tar.gz scala-b1307080fc2fa56602e91524d65a201d9d7974e0.tar.bz2 scala-b1307080fc2fa56602e91524d65a201d9d7974e0.zip |
Docs for MultiMap done. Review by community.p
-rw-r--r-- | src/library/scala/collection/mutable/MultiMap.scala | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/src/library/scala/collection/mutable/MultiMap.scala b/src/library/scala/collection/mutable/MultiMap.scala index fda8524efe..39c51ef5ad 100644 --- a/src/library/scala/collection/mutable/MultiMap.scala +++ b/src/library/scala/collection/mutable/MultiMap.scala @@ -13,16 +13,28 @@ package scala.collection package mutable -/** This class is typically used as a mixin. It turns maps which map <code>A</code> - * to <code>Set[B]</code> objects into multi maps which map <code>A</code> to - * <code>B</code> objects. +/** A trait for mutable maps with multiple values assigned to a key. * + * This class is typically used as a mixin. It turns maps which map `A` + * to `Set[B]` objects into multi maps which map `A` to + * `B` objects. + * + * @define coll multimap + * @define Coll MultiMap * @author Matthias Zenger * @author Martin Odersky * @version 2.8 * @since 1 */ trait MultiMap[A, B] extends Map[A, Set[B]] { + /** Creates a new set. + * + * Classes that use this trait as a mixin can override this method + * to have the desired implementation of sets assigned to new keys. + * By default this is `HashSet`. + * + * @return An empty set of values of type `B`. + */ protected def makeSet: Set[B] = new HashSet[B] @deprecated("use addBinding instead") @@ -51,6 +63,9 @@ trait MultiMap[A, B] extends Map[A, Set[B]] { /** Removes the binding of `value` to `key` if it exists. * + * If this was the last value assigned to the specified key, the + * set assigned to that key will be removed as well. + * * @param key The key of the binding. * @param value The value to remove. * @return A reference to this multimap. |