scala-collection-contrib
API
Generated with
scala-collection-contrib/scala.collection/MultiDict

MultiDict

scala.collection.MultiDict
See theMultiDict companion object
trait MultiDict[K, V] extends Iterable[(K, V)], MultiDictOps[K, V, MultiDict, MultiDict[K, V]], Equals

A multidict is a map that can associate a set of values to a given key.

Type parameters

K

the type of keys

V

the type of values

Attributes

Companion
object
Graph
Supertypes
trait Equals
trait MultiDictOps[K, V, MultiDict, MultiDict[K, V]]
trait Iterable[(K, V)]
trait IterableFactoryDefaults[(K, V), Iterable]
trait IterableOps[(K, V), Iterable, MultiDict[K, V]]
trait IterableOnceOps[(K, V), Iterable, MultiDict[K, V]]
trait IterableOnce[(K, V)]
class Object
trait Matchable
class Any
Show all
Known subtypes
class MultiDict[K, V]
class MultiDict[K, V]
trait SortedMultiDict[K, V]
class SortedMultiDict[K, V]
class SortedMultiDict[K, V]

Members list

Value members

Concrete methods

def canEqual(that: Any): Boolean
override def empty: MultiDict[K, V]

Attributes

Definition Classes
IterableFactoryDefaults -> IterableOps
override def equals(o: 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
Equals -> Any
override def hashCode(): Int

Calculates a hash code value for the object.

Calculates 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 multiDictFactory: MapFactory[MultiDict]
override def withFilter(p: ((K, V)) => Boolean): WithFilter[K, V, Iterable, MultiDict]

Attributes

Definition Classes
IterableOps

Inherited methods

final def ++[B >: (K, V)](suffix: IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
override def addString(sb: StringBuilder, start: String, sep: String, end: String): sb.type

Attributes

Definition Classes
MultiDictOps -> IterableOnceOps
Inherited from:
MultiDictOps
final def addString(b: StringBuilder): b.type

Attributes

Inherited from:
IterableOnceOps
final def addString(b: StringBuilder, sep: String): b.type

Attributes

Inherited from:
IterableOnceOps
def collect[L, W](pf: PartialFunction[(K, V), (L, W)]): MultiDict[L, W]

Type parameters

L

new type of keys

W

new type of values

Value parameters

pf

transformation to apply

Attributes

Returns

a multidict that contains all the entries of this multidict after they have been successfully transformed by the given partial function pf

Inherited from:
MultiDictOps
def collect[B](pf: PartialFunction[(K, V), B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def collectFirst[B](pf: PartialFunction[(K, V), B]): Option[B]

Attributes

Inherited from:
IterableOnceOps
def collectSets[L, W](pf: PartialFunction[(K, Set[V]), (L, Set[W])]): MultiDict[L, W]

Type parameters

L

the new type of keys

W

the new type of values

Value parameters

pf

the partial function to apply to each set of values

Attributes

Returns

a multidict that contains all the entries of this multidict, after they have been successfully transformed by the given partial function

Inherited from:
MultiDictOps
def concat(that: IterableOnce[(K, V)]): MultiDict[K, V]

Concatenate the entries given in that iterable to this multidict

Concatenate the entries given in that iterable to this multidict

Attributes

Inherited from:
MultiDictOps
def concat[B >: (K, V)](suffix: IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def concatSets(that: Iterable[(K, Set[V])]): MultiDict[K, V]

Value parameters

that

the collection of values to add to this multidict

Attributes

Returns

a new multidict concatenating the values of this multidict and that collection of values

Inherited from:
MultiDictOps
def containsEntry(kv: (K, V)): Boolean

Value parameters

kv

the binding to test

Attributes

Returns

Whether the binding kv is contained in this multidict or not

Inherited from:
MultiDictOps
def containsKey(key: K): Boolean

Value parameters

key

the key to test

Attributes

Returns

Whether key has at least one occurrence in this multidict or not

Inherited from:
MultiDictOps
def containsValue(value: V): Boolean

Value parameters

value

the value to test

Attributes

Returns

Whether at least one key is associated to the given value

Inherited from:
MultiDictOps
def copyToArray[B >: (K, V)](xs: Array[B], start: Int, len: Int): Int

Attributes

Inherited from:
IterableOnceOps
def copyToArray[B >: (K, V)](xs: Array[B], start: Int): Int

Attributes

Inherited from:
IterableOnceOps
def copyToArray[B >: (K, V)](xs: Array[B]): Int

Attributes

Inherited from:
IterableOnceOps
def corresponds[B](that: IterableOnce[B])(p: ((K, V), B) => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def count(p: ((K, V)) => Boolean): Int

Attributes

Inherited from:
IterableOnceOps
def drop(n: Int): MultiDict[K, V]

Attributes

Inherited from:
IterableOps
def dropRight(n: Int): MultiDict[K, V]

Attributes

Inherited from:
IterableOps
def dropWhile(p: ((K, V)) => Boolean): MultiDict[K, V]

Attributes

Inherited from:
IterableOps
def entryExists(key: K, p: V => Boolean): Boolean

Attributes

Returns

Whether there exists a value associated with the given key that satisfies the given predicate p

Inherited from:
MultiDictOps
def exists(p: ((K, V)) => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def filter(pred: ((K, V)) => Boolean): MultiDict[K, V]

Attributes

Inherited from:
IterableOps
def filterNot(pred: ((K, V)) => Boolean): MultiDict[K, V]

Attributes

Inherited from:
IterableOps
def filterSets(p: ((K, Set[V])) => Boolean): MultiDict[K, V]

Attributes

Returns

a multidict that contains all the entries of this multidict that satisfy the predicate p

Inherited from:
MultiDictOps
def find(p: ((K, V)) => Boolean): Option[(K, V)]

Attributes

Inherited from:
IterableOnceOps
def flatMap[L, W](f: ((K, V)) => IterableOnce[(L, W)]): MultiDict[L, W]

Type parameters

L

new type of keys

W

new type of values

Value parameters

f

transformation function

Attributes

Returns

a multidict that contains all the entries of this multidict, transformed by the function f and concatenated

Inherited from:
MultiDictOps
def flatMap[B](f: ((K, V)) => IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def flatMapSets[L, W](f: ((K, Set[V])) => IterableOnce[(L, Set[W])]): MultiDict[L, W]

Type parameters

L

the new type of keys

W

the type of values of the returned multidict

Value parameters

f

the function to apply

Attributes

Returns

a new multidict resulting from applying the given function f to each group of values of this multidict and concatenating the results

Inherited from:
MultiDictOps
def flatten[B](implicit asIterable: ((K, V)) => IterableOnce[B]): Iterable[B]

Attributes

Inherited from:
IterableOps
def fold[A1 >: (K, V)](z: A1)(op: (A1, A1) => A1): A1

Attributes

Inherited from:
IterableOnceOps
def foldLeft[B](z: B)(op: (B, (K, V)) => B): B

Attributes

Inherited from:
IterableOnceOps
def foldRight[B](z: B)(op: ((K, V), B) => B): B

Attributes

Inherited from:
IterableOnceOps
def forall(p: ((K, V)) => Boolean): Boolean

Attributes

Inherited from:
IterableOnceOps
def foreach[U](f: ((K, V)) => U): Unit

Attributes

Inherited from:
IterableOnceOps
def get(key: K): Set[V]

Value parameters

key

key to look up

Attributes

Returns

The set of values associated with the given key, or the empty set if there is no such association

Inherited from:
MultiDictOps
def groupBy[K](f: ((K, V)) => K): Map[K, MultiDict[K, V]]

Attributes

Inherited from:
IterableOps
def groupMap[K, B](key: ((K, V)) => K)(f: ((K, V)) => B): Map[K, Iterable[B]]

Attributes

Inherited from:
IterableOps
def groupMapReduce[K, B](key: ((K, V)) => K)(f: ((K, V)) => B)(reduce: (B, B) => B): Map[K, B]

Attributes

Inherited from:
IterableOps
def grouped(size: Int): Iterator[MultiDict[K, V]]

Attributes

Inherited from:
IterableOps
def head: (K, V)

Attributes

Inherited from:
IterableOps
def headOption: Option[(K, V)]

Attributes

Inherited from:
IterableOps
def init: MultiDict[K, V]

Attributes

Inherited from:
IterableOps
def inits: Iterator[MultiDict[K, V]]

Attributes

Inherited from:
IterableOps
def isEmpty: Boolean

Attributes

Inherited from:
IterableOnceOps
override def isTraversableAgain: Boolean

Attributes

Definition Classes
IterableOps -> IterableOnceOps
Inherited from:
IterableOps
def iterableFactory: IterableFactory[Iterable]

Attributes

Inherited from:
Iterable
def iterator: Iterator[(K, V)]

Attributes

Inherited from:
MultiDictOps
def keySet: Set[K]

Attributes

Returns

the set of keys

Inherited from:
MultiDictOps
def knownSize: Int

Attributes

Inherited from:
IterableOnce
def last: (K, V)

Attributes

Inherited from:
IterableOps
def lastOption: Option[(K, V)]

Attributes

Inherited from:
IterableOps
def lazyZip[B](that: Iterable[B]): LazyZip2[(K, V), B, Iterable.this.type]

Attributes

Inherited from:
Iterable
def map[L, W](f: ((K, V)) => (L, W)): MultiDict[L, W]

Type parameters

L

new type of keys

W

new type of values

Value parameters

f

transformation function

Attributes

Returns

a multidict that contains all the entries of this multidict, transformed by the function f

Inherited from:
MultiDictOps
def map[B](f: ((K, V)) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def mapSets[L, W](f: ((K, Set[V])) => (L, Set[W])): MultiDict[L, W]

Type parameters

L

the new type of keys

W

the type of values of the returned multidict

Value parameters

f

the function to apply

Attributes

Returns

a new multidict resulting from applying the given function f to each group of values of this multidict and collecting the results

Inherited from:
MultiDictOps
def max[B >: (K, V)](implicit ord: Ordering[B]): (K, V)

Attributes

Inherited from:
IterableOnceOps
def maxBy[B](f: ((K, V)) => B)(implicit ord: Ordering[B]): (K, V)

Attributes

Inherited from:
IterableOnceOps
def maxByOption[B](f: ((K, V)) => B)(implicit ord: Ordering[B]): Option[(K, V)]

Attributes

Inherited from:
IterableOnceOps
def maxOption[B >: (K, V)](implicit ord: Ordering[B]): Option[(K, V)]

Attributes

Inherited from:
IterableOnceOps
def min[B >: (K, V)](implicit ord: Ordering[B]): (K, V)

Attributes

Inherited from:
IterableOnceOps
def minBy[B](f: ((K, V)) => B)(implicit ord: Ordering[B]): (K, V)

Attributes

Inherited from:
IterableOnceOps
def minByOption[B](f: ((K, V)) => B)(implicit ord: Ordering[B]): Option[(K, V)]

Attributes

Inherited from:
IterableOnceOps
def minOption[B >: (K, V)](implicit ord: Ordering[B]): Option[(K, V)]

Attributes

Inherited from:
IterableOnceOps
final def mkString: String

Attributes

Inherited from:
IterableOnceOps
final def mkString(sep: String): String

Attributes

Inherited from:
IterableOnceOps
final def mkString(start: String, sep: String, end: String): String

Attributes

Inherited from:
IterableOnceOps
def nonEmpty: Boolean

Attributes

Inherited from:
IterableOnceOps
def partition(p: ((K, V)) => Boolean): (MultiDict[K, V], MultiDict[K, V])

Attributes

Inherited from:
IterableOps
def partitionMap[A1, A2](f: ((K, V)) => Either[A1, A2]): (Iterable[A1], Iterable[A2])

Attributes

Inherited from:
IterableOps
def product[B >: (K, V)](implicit num: Numeric[B]): B

Attributes

Inherited from:
IterableOnceOps
def reduce[B >: (K, V)](op: (B, B) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceLeft[B >: (K, V)](op: (B, (K, V)) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceLeftOption[B >: (K, V)](op: (B, (K, V)) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
def reduceOption[B >: (K, V)](op: (B, B) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
def reduceRight[B >: (K, V)](op: ((K, V), B) => B): B

Attributes

Inherited from:
IterableOnceOps
def reduceRightOption[B >: (K, V)](op: ((K, V), B) => B): Option[B]

Attributes

Inherited from:
IterableOnceOps
protected def reversed: Iterable[(K, V)]

Attributes

Inherited from:
IterableOnceOps
def scan[B >: (K, V)](z: B)(op: (B, B) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def scanLeft[B](z: B)(op: (B, (K, V)) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def scanRight[B](z: B)(op: ((K, V), B) => B): Iterable[B]

Attributes

Inherited from:
IterableOps
def size: Int

Attributes

Inherited from:
IterableOnceOps
def sizeCompare(that: Iterable[_]): Int

Attributes

Inherited from:
IterableOps
def sizeCompare(otherSize: Int): Int

Attributes

Inherited from:
IterableOps
final def sizeIs: SizeCompareOps

Attributes

Inherited from:
IterableOps
def slice(from: Int, until: Int): MultiDict[K, V]

Attributes

Inherited from:
IterableOps
def sliding(size: Int, step: Int): Iterator[MultiDict[K, V]]

Attributes

Inherited from:
IterableOps
def sliding(size: Int): Iterator[MultiDict[K, V]]

Attributes

Inherited from:
IterableOps
def span(p: ((K, V)) => Boolean): (MultiDict[K, V], MultiDict[K, V])

Attributes

Inherited from:
IterableOps
override def splitAt(n: Int): (MultiDict[K, V], MultiDict[K, V])

Attributes

Definition Classes
IterableOps -> IterableOnceOps
Inherited from:
IterableOps
def stepper[S <: Stepper[_]](implicit shape: StepperShape[(K, V), S]): S

Attributes

Inherited from:
IterableOnce
def sum[B >: (K, V)](implicit num: Numeric[B]): B

Attributes

Inherited from:
IterableOnceOps
def tail: MultiDict[K, V]

Attributes

Inherited from:
IterableOps
def tails: Iterator[MultiDict[K, V]]

Attributes

Inherited from:
IterableOps
def take(n: Int): MultiDict[K, V]

Attributes

Inherited from:
IterableOps
def takeRight(n: Int): MultiDict[K, V]

Attributes

Inherited from:
IterableOps
def takeWhile(p: ((K, V)) => Boolean): MultiDict[K, V]

Attributes

Inherited from:
IterableOps
override def tapEach[U](f: ((K, V)) => U): MultiDict[K, V]

Attributes

Definition Classes
IterableOps -> IterableOnceOps
Inherited from:
IterableOps
def to[C1](factory: Factory[(K, V), C1]): C1

Attributes

Inherited from:
IterableOnceOps
def toArray[B >: (K, V) : ClassTag]: Array[B]

Attributes

Inherited from:
IterableOnceOps
final def toBuffer[B >: (K, V)]: Buffer[B]

Attributes

Inherited from:
IterableOnceOps
def toIndexedSeq: IndexedSeq[(K, V)]

Attributes

Inherited from:
IterableOnceOps
def toList: List[(K, V)]

Attributes

Inherited from:
IterableOnceOps
def toMap[K, V](implicit ev: (K, V) <:< (K, V)): Map[K, V]

Attributes

Inherited from:
IterableOnceOps
def toSeq: Seq[(K, V)]

Attributes

Inherited from:
IterableOnceOps
def toSet[B >: (K, V)]: Set[B]

Attributes

Inherited from:
IterableOnceOps
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
Iterable -> Any
Inherited from:
Iterable
def toVector: Vector[(K, V)]

Attributes

Inherited from:
IterableOnceOps
def transpose[B](implicit asIterable: ((K, V)) => Iterable[B]): Iterable[Iterable[B]]

Attributes

Inherited from:
IterableOps
def unzip[A1, A2](implicit asPair: ((K, V)) => (A1, A2)): (Iterable[A1], Iterable[A2])

Attributes

Inherited from:
IterableOps
def unzip3[A1, A2, A3](implicit asTriple: ((K, V)) => (A1, A2, A3)): (Iterable[A1], Iterable[A2], Iterable[A3])

Attributes

Inherited from:
IterableOps
def values: Iterable[V]

Attributes

Returns

all the values contained in this multidict

Inherited from:
MultiDictOps
def view: View[(K, V)]

Attributes

Inherited from:
IterableOps
def zip[B](that: IterableOnce[B]): Iterable[((K, V), B)]

Attributes

Inherited from:
IterableOps
def zipAll[A1 >: (K, V), B](that: Iterable[B], thisElem: A1, thatElem: B): Iterable[(A1, B)]

Attributes

Inherited from:
IterableOps
def zipWithIndex: Iterable[((K, V), Int)]

Attributes

Inherited from:
IterableOps

Inherited and Abstract methods

def sets: Map[K, Set[V]]

Attributes

Returns

All the elements contained in this multidict, grouped by key

Inherited from:
MultiDictOps

Deprecated and Inherited methods

def ++:[B >: (K, V)](that: IterableOnce[B]): Iterable[B]

Attributes

Deprecated
[Since version 2.13.0] Use ++ instead of ++: for collections of type Iterable
Inherited from:
IterableOps
final def /:[B](z: B)(op: (B, (K, V)) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldLeft instead of /:
Inherited from:
IterableOnceOps
final def :\[B](z: B)(op: ((K, V), B) => B): B

Attributes

Deprecated
[Since version 2.13.0] Use foldRight instead of :\\
Inherited from:
IterableOnceOps
def aggregate[B](z: => B)(seqop: (B, (K, V)) => B, combop: (B, B) => B): B

Attributes

Deprecated
[Since version 2.13.0] For sequential collections, prefer `foldLeft(z)(seqop)`. For parallel collections, use `ParIterableLike#aggregate`.
Inherited from:
IterableOnceOps
def companion: IterableFactory[Iterable]

Attributes

Deprecated
[Since version 2.13.0] Use iterableFactory instead
Inherited from:
IterableOps
final def copyToBuffer[B >: (K, V)](dest: Buffer[B]): Unit

Attributes

Deprecated
[Since version 2.13.0] Use `dest ++= coll` instead
Inherited from:
IterableOnceOps
def hasDefiniteSize: Boolean

Attributes

Deprecated
[Since version 2.13.0] Check .knownSize instead of .hasDefiniteSize for more actionable information (see scaladoc for details)
Inherited from:
IterableOnceOps
final def repr: MultiDict[K, V]

Attributes

Deprecated
[Since version 2.13.0] Use coll instead of repr in a collection implementation, use the collection value itself from the outside
Inherited from:
IterableOps
def seq: Iterable.this.type

Attributes

Deprecated
[Since version 2.13.0] Iterable.seq always returns the iterable itself
Inherited from:
Iterable
final def toIterable: Iterable.this.type

Attributes

Deprecated
[Since version 2.13.7] toIterable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
Iterable
final def toIterator: Iterator[(K, V)]

Attributes

Deprecated
[Since version 2.13.0] Use .iterator instead of .toIterator
Inherited from:
IterableOnceOps
final def toStream: Stream[(K, V)]

Attributes

Deprecated
[Since version 2.13.0] Use .to(LazyList) instead of .toStream
Inherited from:
IterableOnceOps
final def toTraversable: Iterable[(K, V)]

Attributes

Deprecated
[Since version 2.13.0] toTraversable is internal and will be made protected; its name is similar to `toList` or `toSeq`, but it doesn\'t copy non-immutable collections
Inherited from:
IterableOps
def view(from: Int, until: Int): View[(K, V)]

Attributes

Deprecated
[Since version 2.13.0] Use .view.slice(from, until) instead of .view(from, until)
Inherited from:
IterableOps
Generated with