Packages

final class NonEmptyMap[K, V] extends AnyRef

A non-empty wrapper for the scala immutable map. Note - this does not attempt to implement all features of map but what the author considers to be the "normal ones".

Self Type
NonEmptyMap[K, V]
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 +(elem: (K, V)): NonEmptyMap[K, V]

    Creates a new NonEmptyMap with an additional element, unless the element is already present.

    Creates a new NonEmptyMap with an additional element, unless the element is already present.

    elem

    the element to be added

    returns

    a new map that contains all elements of this map and that also contains elem.

  2. def ++(elems: Iterable[(K, V)]): NonEmptyMap[K, V]

    Creates a new NonEmptyMap by adding all elements contained in another collection to this NonEmptyMap, omitting duplicates.

    Creates a new NonEmptyMap by adding all elements contained in another collection to this NonEmptyMap, omitting duplicates.

    This method takes a collection of elements and adds all elements, omitting duplicates, into NonEmptyMap.

    Example:

    scala> val a = NonEmptyMap(1, 2) ++ NonEmptyMap(2, "a")
a: zio.prelude.NonEmptyMap[Any] = NonEmptyMap(1, 2, a)
    elems

    the collection containing the elements to add.

    returns

    a new NonEmptyMap with the given elements added, omitting duplicates.

  3. def add(elem: (K, V)): NonEmptyMap[K, V]

    Adds the elem to this NonEmptyMap.

    Adds the elem to this NonEmptyMap. Alias for +.

  4. def equals(that: Any): Boolean
    Definition Classes
    NonEmptyMap → AnyRef → Any
  5. def hashCode(): Int
    Definition Classes
    NonEmptyMap → AnyRef → Any
  6. def keySet: NonEmptySet[K]
  7. def mapValues[V1](f: (V) => V1): NonEmptyMap[K, V1]

    Produces a new non empty map where values mapped according to function f.

    Produces a new non empty map where values mapped according to function f. For compatibility does not use map.iew

  8. def peel: ((K, V), Map[K, V])

    Returns an element of this NonEmptyMap and the remainder, which is a (possibly empty) Map.

    Returns an element of this NonEmptyMap and the remainder, which is a (possibly empty) Map.

    Annotations
    @inline()
  9. def peelNonEmpty: ((K, V), Option[NonEmptyMap[K, V]])

    Returns an element of this NonEmptyMap and the remainder or None, if the remainder is empty.

  10. def remove(elem: K): Map[K, V]

    Removes the elem from this NonEmptyMap.

    Removes the elem from this NonEmptyMap. Alias for -.

  11. def tailNonEmpty: Option[NonEmptyMap[K, V]]

    Returns the tail of this NonEmptyMap if it exists or None otherwise.

  12. def toMap: Map[K, V]

    Converts this NonEmptyMap to a Map.

  13. def toString(): String
    Definition Classes
    NonEmptyMap → AnyRef → Any
  14. def values: NonEmptyChunk[V]