Scalactic 3.3.0-SNAP4/org.scalactic.anyvals/NonEmptyMap

NonEmptyMap

object NonEmptyMap

Companion object for class NonEmptyMap.

Companion:
class
Source:
NonEmptyMap.scala
class Object
trait Matchable
class Any

Value members

Concrete methods

def apply[K, V](firstElement: (K, V), otherElements: (K, V)*): NonEmptyMap[K, V]

Constructs a new NonEmptyMap given at least one element.

Constructs a new NonEmptyMap given at least one element.

Type parameters:
K

the type of the key contained in the new NonEmptyMap

V

the type of the value contained in the new NonEmptyMap

Value parameters:
firstElement

the first element (with index 0) contained in this NonEmptyMap

otherElements

a varargs of zero or more other elements (with index 1, 2, 3, ...) contained in this NonEmptyMap

Source:
NonEmptyMap.scala
def from[K, V](seq: Seq[(K, V)]): Option[NonEmptyMap[K, V]]

Optionally construct a NonEmptyMap containing the elements, if any, of a given GenSeq.

Optionally construct a NonEmptyMap containing the elements, if any, of a given GenSeq.

Type parameters:
K

the type of the key contained in the new NonEmptyMap

V

the type of the value contained in the new NonEmptyMap

Value parameters:
seq

the GenSeq with which to construct a NonEmptyMap

Returns:

a NonEmptyMap containing the elements of the given GenSeq, if non-empty, wrapped in a Some; else None if the GenSeq is empty

Source:
NonEmptyMap.scala
def from[K, V](map: Map[K, V]): Option[NonEmptyMap[K, V]]
def unapplySeq[K, V](nonEmptyMap: NonEmptyMap[K, V]): Option[Seq[(K, V)]]

Variable argument extractor for NonEmptyMaps.

Variable argument extractor for NonEmptyMaps.

Type parameters:
K

the type of the key contained in the NonEmptyMap

V

the type of the value contained in the NonEmptyMap

Value parameters:
nonEmptyMap:

the NonEmptyMap containing the elements to extract

Returns:

an Seq containing this NonEmptyMaps elements, wrapped in a Some

Source:
NonEmptyMap.scala

Implicits

Implicits

implicit def nonEmptyMapToMap[K, V](nonEmptyMap: NonEmptyMap[K, V]): Map[K, V]

Implicit conversion from NonEmptyMap to Map.

Implicit conversion from NonEmptyMap to Map.

One use case for this implicit conversion is to enable GenSeq[NonEmptyMap]s to be flattened. Here's an example:

scala> Vector(NonEmptyMap(1, 2, 3), NonEmptyMap(3, 4), NonEmptyMap(5, 6, 7, 8)).flatten
res0: scala.collection.immutable.Vector[Int] = Vector(1, 2, 3, 3, 4, 5, 6, 7, 8)
Type parameters:
K

the type of the key contained in the NonEmptyMap

V

the type of the value contained in the NonEmptyMap

Value parameters:
nonEmptyMap

the NonEmptyMap to convert to a Map

Returns:

a Map containing the elements, in order, of this NonEmptyMap

Source:
NonEmptyMap.scala