Map.remove to return removed value

[scabug]

mutable.Map should have method

def remove(key: A): Option[B]

immutable.Map should have method

def remove(key: A): (Option[B], Map[A, B])

Use case for mutable.Map:

val params: mutable.Map[String, String] = ...

val force = params.remove("force").isDefined
val quiet = params.remove("quiet").isDefined
val suffix = params.remove("suffix").getOrElse("~")

if (!params.isEmpty) throw new Exception("unknown parameters: " + params.keySet)

[scabug]

Imported From: https://issues.scala-lang.org/browse/SI-46?orig=1
Reporter: Commit Message Bot (anonymous)
Assignee: @mcdirmid

[scabug]

@mcdirmid said:
Method already in JCL as removeKey, added removeKey and put (both return options) to mutable map. Didn't use remove because JCL MutableIterable has a generic remove method that will conflict in JCL Map. Both removeKey and put are not implemented efficiently for mutable maps but are for JCL maps (I don't want to muck with the mutable maps to get them to work like that).

I don't think we should add these methods to immutable maps, the APIs are already complicated enough without multi-return values.

Temporary workaround:

val params: jcl.HashMap[String, String] = ...

val force = params.removeKey("force").isDefined
val quiet = params.removeKey("quiet").isDefined
val suffix = params.removeKey("suffix").getOrElse("~")

if (!params.isEmpty) throw new Exception("unknown parameters: " +
params.keySet)
{code}

[scabug]

@mcdirmid said:
removeKey is in mutable map now. Use removeKey and not remove if you want a return value.

[scabug]

@odersky said:
Milestone 2.6.1 deleted