Map abstract class

An collection of key-value pairs, from which you retrieve a value using its associated key.

There is a finite number of keys in the map, and each key has exactly one value associated with it.

Maps, and their keys and values, can be iterated. The order of iteration is defined by the individual type of map. Examples:

The plain HashMap is unordered (no order is guaranteed),
the LinkedHashMap iterates in key insertion order,
and a sorted map like SplayTreeMap iterates the keys in sorted order.

It is generally not allowed to modify the map (add or remove keys) while an operation is being performed on the map, for example in functions called during a forEach or putIfAbsent call. Modifying the map while iterating the keys or values may also break the iteration.

Implemented by

Constructors

Map() factory: Creates a Map instance with the default implementation, LinkedHashMap.
Map.from(Map other) factory: Creates a LinkedHashMap instance that contains all key-value pairs of other.
Map.fromIterable(Iterable iterable, { K key(element), V value(element) }) factory: Creates a Map instance in which the keys and values are computed from the iterable.
Map.fromIterables(Iterable<K> keys, Iterable<V> values) factory: Creates a Map instance associating the given keys to values.
Map.identity() factory: Creates an identity map with the default implementation, LinkedHashMap.
Map.unmodifiable(Map other) factory: Creates an unmodifiable hash based map containing the entries of other.

Properties

isEmpty → bool read-only: Returns true if there is no key-value pair in the map.
isNotEmpty → bool read-only: Returns true if there is at least one key-value pair in the map.
keys → Iterable<K> read-only: The keys of this.
length → int read-only: The number of key-value pairs in the map.
values → Iterable<V> read-only: The values of this.
hashCode → int read-only, inherited: The hash code for this object.
runtimeType → Type read-only, inherited: A representation of the runtime type of the object.

Operators

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

Methods

addAll(Map<K, V> other) → void: Adds all key-value pairs of other to this map.
clear() → void: Removes all pairs from the map.
containsKey(Object key) → bool: Returns true if this map contains the given key.
containsValue(Object value) → bool: Returns true if this map contains the given value.
forEach(void f(K key, V value)) → void: Applies f to each key-value pair of the map.
putIfAbsent(K key, V ifAbsent()) → V: Look up the value of key, or add a new value if it isn't there.
remove(Object key) → V: Removes key and its associated value, if present, from the map.
noSuchMethod(Invocation invocation) → dynamic inherited: Invoked when a non-existent method or property is accessed.
toString() → String inherited: Returns a string representation of this object.

© 2012 the Dart project authors
Licensed under the Creative Commons Attribution-ShareAlike License v4.0.
https://api.dartlang.org/stable/1.24.3/dart-core/Map-class.html