NonEmptyMap

zio.prelude.NonEmptyMap
See theNonEmptyMap companion object
final class NonEmptyMap[K, V]

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

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
NonEmptyMap[K, V]

Members list

Value members

Concrete methods

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.

Value parameters

elem

the element to be added

Attributes

Returns

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

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)

Value parameters

elems

the collection containing the elements to add.

Attributes

Returns

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

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

Adds the elem to this NonEmptyMap. Alias for +.

Adds the elem to this NonEmptyMap. Alias for +.

Attributes

override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
def mapValues[V1](f: V => V1): NonEmptyMap[K, V1]

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

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

Attributes

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.

Attributes

def peelNonEmpty: ((K, V), Option[NonEmptyMap[K, V]])

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

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

Attributes

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

Removes the elem from this NonEmptyMap. Alias for -.

Removes the elem from this NonEmptyMap. Alias for -.

Attributes

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

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

Attributes

def toMap: Map[K, V]

Converts this NonEmptyMap to a Map.

Converts this NonEmptyMap to a Map.

Attributes

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any