Dart API Referencedart:coreMap<K, V>

Map<K, V> interface

A Map is an associative container, mapping a key to a value. Null values are supported, but null keys are not.

interface Map<K, V> default HashMapImplementation<K, V> {
  /**
   * Creates a map with the default implementation.
   */
  Map();

  /**
   * Creates a [Map] that contains all key value pairs of [other].
   */
  Map.from(Map<K, V> other);


  /**
   * Returns whether this map contains the given [value].
   */
  bool containsValue(V value);

  /**
   * Returns whether this map contains the given [key].
   */
  bool containsKey(K key);

  /**
   * Returns the value for the given [key] or null if [key] is not
   * in the map. Because null values are supported, one should either
   * use containsKey to distinguish between an absent key and a null
   * value, or use the [putIfAbsent] method.
   */
  V operator [](K key);

  /**
   * Associates the [key] with the given [value].
   */
  void operator []=(K key, V value);

  /**
   * If [key] is not associated to a value, calls [ifAbsent] and
   * updates the map by mapping [key] to the value returned by
   * [ifAbsent]. Returns the value in the map.
   */
  V putIfAbsent(K key, V ifAbsent());

  /**
   * Removes the association for the given [key]. Returns the value for
   * [key] in the map or null if [key] is not in the map. Note that values
   * can be null and a returned null value does not always imply that the
   * key is absent.
   */
  V remove(K key);

  /**
   * Removes all pairs from the map.
   */
  void clear();

  /**
   * Applies [f] to each {key, value} pair of the map.
   */
  void forEach(void f(K key, V value));

  /**
   * Returns a collection containing all the keys in the map.
   */
  Collection<K> getKeys();

  /**
   * Returns a collection containing all the values in the map.
   */
  Collection<V> getValues();

  /**
   * The number of {key, value} pairs in the map.
   */
  int get length;

  /**
   * Returns true if there is no {key, value} pair in the map.
   */
  bool isEmpty();
}

Default class

HashMapImplementation<K, V>

Subinterfaces

HashMap<K, V>

Implemented by

AbstractMap<K, V>, AttributeMap, SplayTreeMap<K, V>, Storage

Constructors

new Map() #

Creates a map with the default implementation.

Map();

new Map.from(Map<K, V> other) #

Creates a Map that contains all key value pairs of other.

Map.from(Map<K, V> other);

Properties

final int length #

The number of {key, value} pairs in the map.

int get length;

Operators

V operator [](K key) #

Returns the value for the given key or null if key is not in the map. Because null values are supported, one should either use containsKey to distinguish between an absent key and a null value, or use the putIfAbsent method.

V operator [](K key);

void operator []=(K key, V value) #

Associates the key with the given value.

void operator []=(K key, V value);

Methods

void clear() #

Removes all pairs from the map.

void clear();

bool containsKey(K key) #

Returns whether this map contains the given key.

bool containsKey(K key);

bool containsValue(V value) #

Returns whether this map contains the given value.

bool containsValue(V value);

void forEach(void f(K key, V value)) #

Applies f to each {key, value} pair of the map.

void forEach(void f(K key, V value));

Collection<K> getKeys() #

Returns a collection containing all the keys in the map.

Collection<K> getKeys();

Collection<V> getValues() #

Returns a collection containing all the values in the map.

Collection<V> getValues();

bool isEmpty() #

Returns true if there is no {key, value} pair in the map.

bool isEmpty();

V putIfAbsent(K key, V ifAbsent()) #

If key is not associated to a value, calls ifAbsent and updates the map by mapping key to the value returned by ifAbsent. Returns the value in the map.

V putIfAbsent(K key, V ifAbsent());

V remove(K key) #

Removes the association for the given key. Returns the value for key in the map or null if key is not in the map. Note that values can be null and a returned null value does not always imply that the key is absent.

V remove(K key);