SortedMap<K extends Comparable, V> class Null safety

A Map of objects that can be ordered relative to each other.

Implemented types
Implementers

Constructors

SortedMap([Ordering ordering = const Ordering.byKey()])
Creates a SortedMap instance with an optional ordering.
factory
SortedMap.from(Map<K, V> other, [Ordering ordering = const Ordering.byKey()])
Creates a SortedMap that contains all key/value pairs of other.
factory
SortedMap.fromIterable(Iterable iterable, {K key(dynamic)?, V value(dynamic)?, Ordering ordering = const Ordering.byKey()})
Creates a SortedMap where the keys and values are computed from the iterable.
factory
SortedMap.fromIterables(Iterable<K> keys, Iterable<V> values, [Ordering ordering = const Ordering.byKey()])
Creates a SortedMap associating the given keys to values.
factory

Properties

entries Iterable<MapEntry<K, V>>
The map entries of this.
read-onlyinherited
hashCode int
The hash code for this object.
read-onlyinherited
isEmpty bool
Whether there is no key/value pair in the map.
read-onlyinherited
isNotEmpty bool
Whether there is at least one key/value pair in the map.
read-onlyinherited
keys Iterable<K>
The keys of this.
read-onlyinherited
length int
The number of key/value pairs in the map.
read-onlyinherited
ordering Ordering
The ordering.
read-only
runtimeType Type
A representation of the runtime type of the object.
read-onlyinherited
values Iterable<V>
The values of this.
read-onlyinherited

Methods

addAll(Map<K, V> other) → void
Adds all key/value pairs of other to this map.
inherited
addEntries(Iterable<MapEntry<K, V>> newEntries) → void
Adds all key/value pairs of newEntries to this map.
inherited
cast<RK, RV>() Map<RK, RV>
Provides a view of this map as having RK keys and RV instances, if necessary.
inherited
clear() → void
Removes all entries from the map.
inherited
clone() SortedMap<K, V>
Makes a copy of this map. The key/value pairs in the map are not cloned.
containsKey(Object? key) bool
Whether this map contains the given key.
inherited
containsValue(Object? value) bool
Whether this map contains the given value.
inherited
filteredMap({required Pair start, required Pair end, int? limit, bool reversed = false}) FilteredMap<K, V>
Creates a filtered map based on this map.
filteredMapView({required Pair start, required Pair end, int? limit, bool reversed = false}) FilteredMapView<K, V>
Creates a filtered view of this map.
firstKeyAfter(K key, {K orElse()?}) → K
Get the first key in the map for which the key/value pair is strictly larger than that of key.
forEach(void action(K key, V value)) → void
Applies action to each key/value pair of the map.
inherited
lastKeyBefore(K key, {K orElse()?}) → K
Get the last key in the map for which the key/value pair is strictly smaller than that of key.
map<K2, V2>(MapEntry<K2, V2> convert(K key, V value)) Map<K2, V2>
Returns a new map where all entries of this map are transformed by the given convert function.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
putIfAbsent(K key, V ifAbsent()) → V
Look up the value of key, or add a new entry if it isn't there.
inherited
remove(Object? key) → V?
Removes key and its associated value, if present, from the map.
inherited
removeWhere(bool test(K key, V value)) → void
Removes all entries of this map that satisfy the given test.
inherited
subkeys({required Pair start, required Pair end, int? limit, bool reversed = false}) Iterable<K>
Gets the keys within the desired bounds and limit.
toString() String
A string representation of this object.
inherited
update(K key, V update(V value), {V ifAbsent()?}) → V
Updates the value for the provided key.
inherited
updateAll(V update(K key, V value)) → void
Updates all values.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited
operator [](Object? key) → V?
The value for the given key, or null if key is not in the map.
inherited
operator []=(K key, V value) → void
Associates the key with the given value.
inherited