ScalaTest is brought to you by:

object NonEmptyMap

Companion object for class NonEmptyMap.

Source
NonEmptyMap.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NonEmptyMap
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. 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.

    K

    the type of the key contained in the new NonEmptyMap

    V

    the type of the value contained in the new NonEmptyMap

    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

  2. def from[K, V](map: GenMap[K, V]): Option[NonEmptyMap[K, V]]
  3. def from[K, V](seq: GenSeq[(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.

    K

    the type of the key contained in the new NonEmptyMap

    V

    the type of the value contained in the new NonEmptyMap

    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

  4. 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)

    K

    the type of the key contained in the NonEmptyMap

    V

    the type of the value contained in the NonEmptyMap

    nonEmptyMap

    the NonEmptyMap to convert to a Map

    returns

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

  5. def unapplySeq[K, V](nonEmptyMap: NonEmptyMap[K, V]): Option[Seq[(K, V)]]

    Variable argument extractor for NonEmptyMaps.

    Variable argument extractor for NonEmptyMaps.

    K

    the type of the key contained in the NonEmptyMap

    V

    the type of the value contained in the NonEmptyMap

    returns

    an Seq containing this NonEmptyMaps elements, wrapped in a Some