From cb7655df50df7a8c14848687ee43a5a69ad802dc Mon Sep 17 00:00:00 2001
From: "Scott R. Parish" <srp@srparish.net>
Date: Tue, 15 May 2012 15:50:05 -0500
Subject: mutable.MapLike: override $mapNote to reflect actual require mutable
 api

The api needed to define a mutable.Map is different then the one
needed to define an immutable.Map. Prior to this patch the mutable one
reflected the api needed for the immutable one causing confusion about
what really needed to be defined.
---
 src/library/scala/collection/mutable/MapLike.scala | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'src/library')

diff --git a/src/library/scala/collection/mutable/MapLike.scala b/src/library/scala/collection/mutable/MapLike.scala
index b8b1152099..3046207533 100644
--- a/src/library/scala/collection/mutable/MapLike.scala
+++ b/src/library/scala/collection/mutable/MapLike.scala
@@ -18,6 +18,28 @@ import parallel.mutable.ParMap
  *  $mapNote
  *  $mapTags
  *  @since   2.8
+ *
+ * @define mapNote
+ *    '''Implementation note:'''
+ *    This trait provides most of the operations of a mutable `Map`
+ *    independently of its representation. It is typically inherited by
+ *    concrete implementations of maps.
+ *
+ *    To implement a concrete mutable map, you need to provide
+ *    implementations of the following methods:
+ *    {{{
+ *       def get(key: A): Option[B]
+ *       def iterator: Iterator[(A, B)]
+ *       def += (kv: (A, B)): This
+ *       def -= (key: A): This
+ *    }}}
+ *    If you wish that methods like `take`, `drop`, `filter` also return the same kind of map
+ *    you should also override:
+ *    {{{
+ *       def empty: This
+ *    }}}
+ *    It is also good idea to override methods `foreach` and
+ *    `size` for efficiency.
  */
 trait MapLike[A, B, +This <: MapLike[A, B, This] with Map[A, B]]
   extends scala.collection.MapLike[A, B, This]
-- 
cgit v1.2.3