MapValueSet<K, V> class

Creates a modifiable Set view of the values of a Map.

The Set view assumes that the keys of the Map can be uniquely determined from the values. The keyForValue function passed to the constructor finds the key for a single value. The keyForValue function should be consistent with equality. If value1 == value2 then keyForValue(value1) and keyForValue(value2) should be considered equal keys by the underlying map, and vice versa.

Modifying the set will modify the underlying map based on the key returned by keyForValue.

If the Map contents are not compatible with the keyForValue function, the set will not work consistently, and may give meaningless responses or do inconsistent updates.

This set can, for example, be used on a map from database record IDs to the records. It exposes the records as a set, and allows for writing both recordSet.add(databaseRecord) and recordMap[id].

Effectively, the map will act as a kind of index for the set.

Implemented types

Constructors

MapValueSet(Map<K, V> base, K keyForValue(V value))
Creates a new MapValueSet based on base. [...]

Properties

isEmpty bool
Returns true if there are no elements in this collection. [...]
read-only
isNotEmpty bool
Returns true if there is at least one element in this collection. [...]
read-only
length int
Returns the number of elements in this. [...]
read-only
first → V
Returns the first element. [...]
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
iterator Iterator<V>
Returns a new Iterator that allows iterating the elements of this Iterable. [...]
read-only, inherited
last → V
Returns the last element. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
single → V
Checks that this iterable has only one element, and returns that element. [...]
read-only, inherited

Methods

add(V value) bool
Adds value to the set. [...]
override
addAll(Iterable<V> elements) → void
Adds all elements to this Set. [...]
override
cast<T>() Set<T>
Provides a view of this iterable as an iterable of R instances. [...]
clear() → void
Removes all elements in the set.
override
contains(Object element) bool
Returns true if the collection contains an element equal to element. [...]
containsAll(Iterable<Object> other) bool
Returns whether this Set contains all the elements of other.
override
difference(Set<Object> other) Set<V>
Returns a new set with the the elements of this that are not in other. [...]
override
intersection(Set<Object> other) Set<V>
Returns a new set which is the intersection between this and other. [...]
override
lookup(Object element) → V
If an object equal to object is in the set, return it. [...]
override
remove(Object element) bool
Removes value from the set. Returns true if value was in the set. Returns false otherwise. The method has no effect if value value was not in the set.
override
removeAll(Iterable<Object> elements) → void
Removes each element of elements from this set.
override
removeWhere(bool test(V element)) → void
Removes all elements of this set that satisfy test.
override
retainAll(Iterable<Object> elements) → void
Removes all elements of this set that are not elements in elements. [...]
override
retainWhere(bool test(V element)) → void
Removes all elements of this set that fail to satisfy test.
override
retype<T>() Set<T>
toString() String
Returns a string representation of this object.
union(Set<V> other) Set<V>
Returns a new set which contains all the elements of this and other. [...]
override
any(bool test(V element)) bool
Checks whether any element of this iterable satisfies test. [...]
inherited
elementAt(int index) → V
Returns the indexth element. [...]
inherited
every(bool test(V element)) bool
Checks whether every element of this iterable satisfies test. [...]
inherited
expand<T>(Iterable<T> f(V element)) Iterable<T>
Expands each element of this Iterable into zero or more elements. [...]
inherited
firstWhere(bool test(V element), {V orElse()}) → V
Returns the first element that satisfies the given predicate test. [...]
inherited
fold<T>(T initialValue, T combine(T previousValue, V element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value [...]
inherited
followedBy(Iterable<V> other) Iterable<V>
Returns the lazy concatentation of this iterable and other. [...]
inherited
forEach(void f(V element)) → void
Applies the function f to each element of this collection in iteration order.
inherited
join([String separator = ""]) String
Converts each element to a String and concatenates the strings. [...]
inherited
lastWhere(bool test(V element), {V orElse()}) → V
Returns the last element that satisfies the given predicate test. [...]
inherited
map<T>(T f(V element)) Iterable<T>
Returns a new lazy Iterable with elements that are created by calling f on each element of this Iterable in iteration order. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
reduce(V combine(V value, V element)) → V
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function. [...]
inherited
singleWhere(bool test(V element), {V orElse()}) → V
Returns the single element that satisfies test. [...]
inherited
skip(int n) Iterable<V>
Returns an Iterable that provides all but the first count elements. [...]
inherited
skipWhile(bool test(V value)) Iterable<V>
Returns an Iterable that skips leading elements while test is satisfied. [...]
inherited
take(int n) Iterable<V>
Returns a lazy iterable of the count first elements of this iterable. [...]
inherited
takeWhile(bool test(V value)) Iterable<V>
Returns a lazy iterable of the leading elements satisfying test. [...]
inherited
toList({bool growable: true}) List<V>
Creates a List containing the elements of this Iterable. [...]
inherited
toSet() Set<V>
Creates a Set containing the same elements as this iterable. [...]
inherited
where(bool test(V element)) Iterable<V>
Returns a new lazy Iterable with all elements that satisfy the predicate test. [...]
inherited
whereType<T>() Iterable<T>
Returns a new lazy Iterable with all elements that have type T. [...]
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited