guava-kotlin/ca.solostudios.guava.kotlin.collect/ListMultimap

ListMultimap

interface ListMultimap<K, out V> : Multimap<K, V> (source)

A Multimap that can hold duplicate key-value pairs and that maintains the insertion ordering of values for a given key.

See the Multimap documentation for information common to all multimaps.

The get and asMap methods return a List of values.

Methods in this interface support only read-only access to the multimap; read-write access is supported through the MutableListMultimap interface.

See the Guava User Guide article on Multimap.

Parameters

the type of multimap keys. The multimap is invariant in its key type, as it can accept key as a parameter (of containsKey for example) and return it in keys set.

the type of multimap values. The multimap is covariant in its value type.

Functions

asMap

abstract override fun asMap(): Map<K, List<V>>

Returns a view of this multimap as a Map from each distinct key to the nonempty collection of that key's associated values. Note that this.asMap().get(k) is equivalent to this.get(k) only when k is a key contained in the multimap; otherwise it returns null as opposed to an empty collection.

containsEntry

abstract fun containsEntry(entry: Pair<K, V>): Boolean

Returns true if the multimap contains at least one key-value pair with the key key and the value value.

containsKey

abstract fun containsKey(key: K): Boolean

Returns true if the multimap contains the specified key.

containsValue

abstract fun containsValue(value: V): Boolean

Returns true if the multimap maps one or more keys to the specified value.

forEach

open fun forEach(p0: Consumer<in Map.Entry<K, V>>)

get

abstract operator override fun get(key: K): List<V>

Returns a view of the list of all the values corresponding to the given key in the multimap.

isEmpty

abstract fun isEmpty(): Boolean

Returns true if the multimap is empty (contains no elements), false otherwise.

iterator

open operator override fun iterator(): Iterator<Map.Entry<K, V>>

Returns an iterator over the elements of this object.

spliterator

open fun spliterator(): Spliterator<Map.Entry<K, V>>

Properties

entries

abstract val entries: Collection<Map.Entry<K, V>>

Returns a read-only Collection of all key/value pairs in this map.

keys

abstract val keys: Multiset<K>

Returns a read-only Set of all keys in this multimap.

keySet

abstract val keySet: Set<K>

Returns a read-only Set of all the keys in this multimap.

size

abstract val size: Int

Returns the number of key/value pairs in the multimap.

values

abstract val values: Collection<V>

Returns a read-only Collection of all values in this map. Note that this collection may contain duplicate values.

Inheritors

MutableListMultimap

Extensions

all

inline fun <T> Iterable<T>.all(noinline predicate: (T) -> Boolean): Boolean

Returns true if every element in this satisfies the predicate. If this is empty, true is returned.

any

inline fun <T> Iterable<T>.any(noinline predicate: (T) -> Boolean): Boolean

Returns true if any element in this satisfies the predicate.

asString

inline fun <T> Iterable<T>.asString(): String

Returns a string representation of this, with the format [e1, e2, ..., en] (that is, identical to Arrays.toString(Iterables.toArray(iterable))). Note that for most implementations of Collection, collection.toString() also gives the same result, but that behavior is not generally guaranteed.

concat

infix inline fun <T> Iterable<T>.concat(other: Iterable<T>): Iterable<T>

Combines two iterables into a single iterable. The returned iterable has an iterator that traverses the elements in this, followed by the elements in other. The source iterators are not polled until necessary.

inline fun <T> Iterable<T>.concat(a: Iterable<T>, b: Iterable<T>): Iterable<T>

Combines three iterables into a single iterable. The returned iterable has an iterator that traverses the elements in this, followed by the elements in a, followed by the elements in b. The source iterators are not polled until necessary.

inline fun <T> Iterable<T>.concat(a: Iterable<T>, b: Iterable<T>, c: Iterable<T>): Iterable<T>

Combines four iterables into a single iterable. The returned iterable has an iterator that traverses the elements in this, followed by the elements in a, followed by the elements in b, followed by the elements in c. The source iterators are not polled until necessary.

inline fun <T> Iterable<T>.concat(vararg iterables: Iterable<T>): Iterable<T>

Combines multiple iterables into a single iterable. The returned iterable has an iterator that traverses the elements in this, followed by the elements of each iterable in iterables sequentially. The source iterators are not polled until necessary.

cycleIterable

inline fun <T> Iterable<T>.cycleIterable(): Iterable<T>

Returns an iterable whose iterators cycle indefinitely over the elements of this.

cycleIterator

inline fun <T> Iterable<T>.cycleIterator(): Iterator<T>

Returns an iterator that cycles indefinitely over the elements of this.

elementsEqual

inline fun <T> Iterable<T>.elementsEqual(other: Iterable<T>): Boolean

Determines whether two iterables contain equal elements in the same order. More specifically, this method returns true if this and other contain the same number of elements and every element of other is equal to the corresponding element of other.

filterIsInstanceView

inline fun <T> Iterable<*>.filterIsInstanceView(): Iterable<T>

Returns a view of this containing all elements that are of the type T.

filterView

inline fun <T> Iterable<T>.filterView(noinline retainIfTrue: (T) -> Boolean): Iterable<T>

Returns a view of this containing all elements that satisfy the input predicate retainIfTrue.

find

inline fun <T> Iterable<T>.find(defaultValue: T? = null, noinline predicate: (T) -> Boolean): T

Returns the first element in this that satisfies the given predicate; use this method only when such an element is known to exist. If it is possible that no element will match, use tryFind or find instead.

flatConcat

inline fun <T> Iterable<Iterable<T>>.flatConcat(): Iterable<T>

@JvmName(name = "flatConcatMutable")

inline fun <T> Iterable<MutableIterable<T>>.flatConcat(): MutableIterable<T>

Combines multiple iterables into a single iterable. The returned iterable has an iterator that traverses the elements in this sequentially. The source iterators are not polled until necessary.

inline fun <T> Iterable<Iterator<T>>.flatConcat(): Iterator<T>

@JvmName(name = "flatConcatMutable")

inline fun <T> Iterable<MutableIterator<T>>.flatConcat(): MutableIterator<T>

Combines two iterators into a single iterator. The returned iterator iterates across the elements in this sequentially. The source iterators are not polled until necessary.

frequency

inline fun <T> Iterable<T>.frequency(element: T): Int

Returns the number of elements in the specified iterable that equal the specified object. This implementation avoids a full iteration when the iterable is a Multiset or Set.

get

inline operator fun <T> Iterable<T>.get(position: Int): T

Returns the element at the specified position in an iterable.

inline fun <T> Iterable<T>.get(position: Int, defaultValue: T? = null): T

Returns the element at the specified position in an iterable or a default value otherwise.

getFirst

inline fun <T> Iterable<T>.getFirst(defaultValue: T): T

Returns the first element in this or defaultValue if the iterable is empty. The Iterators analog to this method is Iterators.getNext.

getLast

inline fun <T> Iterable<T>.getLast(defaultValue: T? = null): T

Returns the last element of this or defaultValue if the iterable is empty. If this is a List with RandomAccess support, then this operation is guaranteed to be O(1).

indexOf

inline fun <T> Iterable<T>.indexOf(noinline predicate: (T) -> Boolean): Int

Returns the index in this of the first element that satisfies the provided predicate, or -1 if the Iterable has no such elements.

isEmpty

inline fun <T> Iterable<T>.isEmpty(): Boolean

Determines if the given iterable contains no elements.

limit

inline fun <T> Iterable<T>.limit(limitSize: Int): Iterable<T>

Returns a view of this containing its first limitSize elements. If this contains fewer than limitSize elements, the returned view contains all of its elements. The returned iterable's iterator supports remove() if this's iterator does.

mergeSorted

inline fun <T, R : Comparable<R>> Iterable<Iterable<T>>.mergeSorted(crossinline selector: (T) -> Comparable<R>): Iterable<T>

@ExperimentalGuavaCollectionsApi

inline fun <T> Iterable<Iterable<T>>.mergeSorted(comparator: Comparator<T>): Iterable<T>

Returns an iterable over the merged contents of all given Iterables in this. Equivalent entries will not be de-duplicated.

@ExperimentalGuavaCollectionsApi

inline fun <T, R : Comparable<R>> Iterable<Iterator<T>>.mergeSorted(crossinline selector: (T) -> Comparable<R>): Iterator<T>

@ExperimentalGuavaCollectionsApi

inline fun <T> Iterable<Iterator<T>>.mergeSorted(comparator: Comparator<T>): Iterator<T>

Returns an iterator over the merged contents of all given this, traversing every element of the input iterators. Equivalent entries will not be de-duplicated.

orderedPermutations

@ExperimentalGuavaCollectionsApi

inline fun <E : Comparable<E>> Iterable<E>.orderedPermutations(): Collection<List<E>>

Returns a Collection of all the permutations of the specified Iterable using naturalOrder for establishing the lexicographical ordering.

@ExperimentalGuavaCollectionsApi

inline fun <E, R : Comparable<R>> Iterable<E>.orderedPermutations(crossinline selector: (E) -> Comparable<R>): Collection<List<E>>

Returns a Collection of all the permutations of the specified Iterable using the specified selector for establishing the lexicographical ordering.

@ExperimentalGuavaCollectionsApi

inline fun <E> Iterable<E>.orderedPermutations(comparator: Comparator<E>): Collection<List<E>>

Returns a Collection of all the permutations of the specified Iterable using the specified comparator for establishing the lexicographical ordering.

paddedPartition

inline fun <T> Iterable<T>.paddedPartition(size: Int): Iterable<List<T?>>

Divides an iterable into unmodifiable sublists of the given size, padding the final iterable with null values if necessary. For example, partitioning an iterable containing [a, b, c, d, e] with a partition size of 3 yields [[a, b, c], [d, e, null]] -- an outer iterable containing two inner lists of three elements each, all in the original order.

partition

inline fun <T> Iterable<T>.partition(size: Int): Iterable<List<T>>

Divides an iterable into unmodifiable sublists of the given size (the final iterable may be smaller). For example, partitioning an iterable containing [a, b, c, d, e] with a partition size of 3 yields [[a, b, c], [d, e]] -- an outer iterable containing two inner lists of three and two elements, all in the original order.

size

val Iterable<*>.size: Int

Returns the number of elements in this.

skip

inline fun <T> Iterable<T>.skip(numberToSkip: Int): Iterable<T>

Returns a view of this that skips its first numberToSkip elements. If this contains fewer than numberToSkip elements, the returned iterable skips all of its elements.

toGuava