lib/src/collection/delegates/map.dart

// Copyright 2013 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/// An implementation of [Map] that delegates all methods to another [Map].
/// For instance you can create a FruitMap like this :
///
///     class FruitMap extends DelegatingMap<String, Fruit> {
///       final Map<String, Fruit> _fruits = {};
///
///       Map<String, Fruit> get delegate => _fruits;
///
///       // custom methods
///     }
abstract class DelegatingMap<K, V> implements Map<K, V> {
  Map<K, V> get delegate;

  @override
  V? operator [](Object? key) => delegate[key];

  @override
  void operator []=(K key, V value) {
    delegate[key] = value;
  }

  @override
  void addAll(Map<K, V> other) => delegate.addAll(other);

  @override
  void addEntries(Iterable<Object> entries) {
    // TODO(cbracken): Dart 2.0 requires this method to be implemented.
    // Change Iterable<Object> to Iterable<MapEntry<K, V>> when
    // the MapEntry class has been added.
    throw UnimplementedError('addEntries');
  }

  @override
  Map<K2, V2> cast<K2, V2>() {
    // TODO(cbracken): Dart 2.0 requires this method to be implemented.
    throw UnimplementedError('cast');
  }

  @override
  void clear() => delegate.clear();

  @override
  bool containsKey(Object? key) => delegate.containsKey(key);

  @override
  bool containsValue(Object? value) => delegate.containsValue(value);

  @override
  Iterable<MapEntry<K, V>> get entries {
    // TODO(cbracken): Dart 2.0 requires this method to be implemented.
    // Change Iterable<Null> to Iterable<MapEntry<K, V>> when
    // the MapEntry class has been added.
    throw UnimplementedError('entries');
  }

  @override
  void forEach(void Function(K key, V value) f) => delegate.forEach(f);

  @override
  bool get isEmpty => delegate.isEmpty;

  @override
  bool get isNotEmpty => delegate.isNotEmpty;

  @override
  Iterable<K> get keys => delegate.keys;

  @override
  int get length => delegate.length;

  @override
  Map<K2, V2> map<K2, V2>(Object Function(K key, V value) transform) {
    // TODO(cbracken): Dart 2.0 requires this method to be implemented.
    // Change Object to MapEntry<K2, V2> when
    // the MapEntry class has been added.
    throw UnimplementedError('map');
  }

  @override
  V putIfAbsent(K key, V Function() ifAbsent) =>
      delegate.putIfAbsent(key, ifAbsent);

  @override
  V? remove(Object? key) => delegate.remove(key);

  @override
  void removeWhere(bool Function(K key, V value) test) {
    // TODO(cbracken): Dart 2.0 requires this method to be implemented.
    throw UnimplementedError('removeWhere');
  }

  @override
  V update(K key, V Function(V value) update, {V Function()? ifAbsent}) {
    // TODO(cbracken): Dart 2.0 requires this method to be implemented.
    throw UnimplementedError('update');
  }

  @override
  void updateAll(V Function(K key, V value) update) {
    // TODO(cbracken): Dart 2.0 requires this method to be implemented.
    throw UnimplementedError('updateAll');
  }

  @override
  Iterable<V> get values => delegate.values;
}