UnmodifiableMapBase<K, V> abstract#

Basic implementation of an unmodifiable Map.

This class has a basic implementation of all but two of the members of an unmodifiable Map. A simple unmodifiable Map class can be implemented by extending this class and implementing keys and operator[].

Modifying operations throw when used. The remaining non-modifying operations are implemented in terms of keys and operator[].

The keys iterable should have efficient Iterable.length and Iterable.contains operations, and it should catch concurrent modifications of the keys while iterating.

A more efficient implementation is usually possible by overriding some of the other members as well.

Constructors#

UnmodifiableMapBase() const#

Properties#

entries no setter inherited#

The map entries of this Map.

Inherited from MapBase.

Iterable<MapEntry<K, V>> get entries {
  return keys.map((K key) => MapEntry<K, V>(key, this[key] as V));
}

hashCode no setter inherited#

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

external int get hashCode;

isEmpty no setter inherited#

Whether there is no key/value pair in the map.

Inherited from MapBase.

bool get isEmpty => keys.isEmpty;

isNotEmpty no setter inherited#

Whether there is at least one key/value pair in the map.

Inherited from MapBase.

bool get isNotEmpty => keys.isNotEmpty;

keys no setter inherited#

The keys of this Map.

The returned iterable has efficient length and contains operations, based on length and containsKey of the map.

The order of iteration is defined by the individual Map implementation, but must be consistent between changes to the map.

Modifying the map while iterating the keys may break the iteration.

Inherited from MapBase.

Iterable<K> get keys;

length no setter inherited#

The number of key/value pairs in the map.

Inherited from MapBase.

int get length => keys.length;

runtimeType no setter inherited#

A representation of the runtime type of the object.

Inherited from Object.

external Type get runtimeType;

values no setter inherited#

The values of this Map.

The values are iterated in the order of their corresponding keys. This means that iterating keys and values in parallel will provide matching pairs of keys and values.

The returned iterable has an efficient length method based on the length of the map. Its Iterable.contains method is based on == comparison.

Modifying the map while iterating the values may break the iteration.

Inherited from MapBase.

Iterable<V> get values => _MapBaseValueIterable<K, V>(this);

Methods#

addAll() inherited#

This operation is not supported by an unmodifiable map.

Inherited from _UnmodifiableMapMixin.

void addAll(Map<K, V> other) {
  throw UnsupportedError("Cannot modify unmodifiable map");
}

addEntries() inherited#

This operation is not supported by an unmodifiable map.

Inherited from _UnmodifiableMapMixin.

void addEntries(Iterable<MapEntry<K, V>> entries) {
  throw UnsupportedError("Cannot modify unmodifiable map");
}

cast() inherited#

Provides a view of this map as having RK keys and RV instances, if necessary.

If this map is already a Map<RK, RV>, it is returned unchanged.

If this set contains only keys of type RK and values of type RV, all read operations will work correctly. If any operation exposes a non-RK key or non-RV value, the operation will throw instead.

Entries added to the map must be valid for both a Map<K, V> and a Map<RK, RV>.

Methods which accept Object? as argument, like containsKey, remove and operator [], will pass the argument directly to the this map's method without any checks. That means that you can do mapWithStringKeys.cast<int,int>().remove("a") successfully, even if it looks like it shouldn't have any effect.

Inherited from MapBase.

Map<RK, RV> cast<RK, RV>() => Map.castFrom<K, V, RK, RV>(this);

clear() inherited#

This operation is not supported by an unmodifiable map.

Inherited from _UnmodifiableMapMixin.

void clear() {
  throw UnsupportedError("Cannot modify unmodifiable map");
}

containsKey() inherited#

Whether this map contains the given key.

Returns true if any of the keys in the map are equal to key according to the equality used by the map.

final moonCount = <String, int>{'Mercury': 0, 'Venus': 0, 'Earth': 1,
  'Mars': 2, 'Jupiter': 79, 'Saturn': 82, 'Uranus': 27, 'Neptune': 14};
final containsUranus = moonCount.containsKey('Uranus'); // true
final containsPluto = moonCount.containsKey('Pluto'); // false

Inherited from MapBase.

bool containsKey(Object? key) => keys.contains(key);

containsValue() inherited#

Whether this map contains the given value.

Returns true if any of the values in the map are equal to value according to the == operator.

final moonCount = <String, int>{'Mercury': 0, 'Venus': 0, 'Earth': 1,
  'Mars': 2, 'Jupiter': 79, 'Saturn': 82, 'Uranus': 27, 'Neptune': 14};
final moons3 = moonCount.containsValue(3); // false
final moons82 = moonCount.containsValue(82); // true

Inherited from MapBase.

bool containsValue(Object? value) {
  for (K key in keys) {
    if (this[key] == value) return true;
  }
  return false;
}

forEach() inherited#

Applies action to each key/value pair of the map.

Calling action must not add or remove keys from the map.

final planetsByMass = <num, String>{0.81: 'Venus', 1: 'Earth',
  0.11: 'Mars', 17.15: 'Neptune'};

planetsByMass.forEach((key, value) {
  print('$key: $value');
  // 0.81: Venus
  // 1: Earth
  // 0.11: Mars
  // 17.15: Neptune
});

Inherited from MapBase.

void forEach(void action(K key, V value)) {
  for (K key in keys) {
    action(key, this[key] as V);
  }
}

map() inherited#

Returns a new map where all entries of this map are transformed by the given convert function.

Inherited from MapBase.

Map<K2, V2> map<K2, V2>(MapEntry<K2, V2> transform(K key, V value)) {
  var result = <K2, V2>{};
  for (var key in this.keys) {
    var entry = transform(key, this[key] as V);
    result[entry.key] = entry.value;
  }
  return result;
}

noSuchMethod() inherited#

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

putIfAbsent() inherited#

This operation is not supported by an unmodifiable map.

Inherited from _UnmodifiableMapMixin.

V putIfAbsent(K key, V ifAbsent()) {
  throw UnsupportedError("Cannot modify unmodifiable map");
}

remove() inherited#

This operation is not supported by an unmodifiable map.

Inherited from _UnmodifiableMapMixin.

V? remove(Object? key) {
  throw UnsupportedError("Cannot modify unmodifiable map");
}

removeWhere() inherited#

This operation is not supported by an unmodifiable map.

Inherited from _UnmodifiableMapMixin.

void removeWhere(bool test(K key, V value)) {
  throw UnsupportedError("Cannot modify unmodifiable map");
}

toString() inherited#

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from MapBase.

String toString() => mapToString(this);

update() inherited#

This operation is not supported by an unmodifiable map.

Inherited from _UnmodifiableMapMixin.

V update(K key, V update(V value), {V Function()? ifAbsent}) {
  throw UnsupportedError("Cannot modify unmodifiable map");
}

updateAll() inherited#

This operation is not supported by an unmodifiable map.

Inherited from _UnmodifiableMapMixin.

void updateAll(V update(K key, V value)) {
  throw UnsupportedError("Cannot modify unmodifiable map");
}

Operators#

operator ==() inherited#

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

external bool operator ==(Object other);

operator []() inherited#

The value for the given key, or null if key is not in the map.

Some maps allow null as a value. For those maps, a lookup using this operator cannot distinguish between a key not being in the map, and the key being there with a null value. Methods like containsKey or putIfAbsent can be used if the distinction is important.

Inherited from MapBase.

V? operator [](Object? key);

operator []=() inherited#

This operation is not supported by an unmodifiable map.

Inherited from _UnmodifiableMapMixin.

void operator []=(K key, V value) {
  throw UnsupportedError("Cannot modify unmodifiable map");
}