Modernize the package's style.

lib/src/wrappers.dart

 // Copyright (c) 2013, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-/**
- * Delegating wrappers for [Iterable], [List], [Set], [Queue] and [Map].
- *
- * Also adds unmodifiable views for `Set` and `Map`, and a fixed length
- * view for `List`. The unmodifiable list view from `dart:collection` is
- * exported as well, just for completeness.
- */
-library dart.pkg.collection.wrappers;
+import "dart:collection";
+import "dart:math" as math;
 
-import "dart:collection";
-import "dart:math" show Random;
+import "unmodifiable_wrappers.dart";
 
-import "src/unmodifiable_wrappers.dart";
-
-export "src/canonicalized_map.dart";
-export "src/unmodifiable_wrappers.dart";
-
-/**
- * A base class for delegating iterables.
- *
- * Subclasses can provide a [_base] that should be delegated to. Unlike
- * [DelegatingIterable], this allows the base to be created on demand.
- */
+/// A base class for delegating iterables.
+///
+/// Subclasses can provide a [_base] that should be delegated to. Unlike
+/// [DelegatingIterable], this allows the base to be created on demand.
 abstract class _DelegatingIterableBase<E> implements Iterable<E> {
   Iterable<E> get _base;
 
   const _DelegatingIterableBase();
 
   bool any(bool test(E element)) => _base.any(test);
 
   bool contains(Object element) => _base.contains(element);
 
   E elementAt(int index) => _base.elementAt(index);
@@ skipping 45 matching lines @@
 
   List<E> toList({bool growable: true}) => _base.toList(growable: growable);
 
   Set<E> toSet() => _base.toSet();
 
   Iterable<E> where(bool test(E element)) => _base.where(test);
 
   String toString() => _base.toString();
 }
 
-/**
- * Creates an [Iterable] that delegates all operations to a base iterable.
- *
- * This class can be used hide non-`Iterable` methods of an iterable object,
- * or it can be extended to add extra functionality on top of an existing
- * iterable object.
- */
+/// Creates an [Iterable] that delegates all operations to a base iterable.
+///
+/// This class can be used hide non-`Iterable` methods of an iterable object,
+/// or it can be extended to add extra functionality on top of an existing
+/// iterable object.
 class DelegatingIterable<E> extends _DelegatingIterableBase<E> {
   final Iterable<E> _base;
 
-  /**
-   * Create a wrapper that forwards operations to [base].
-   */
+  /// Create a wrapper that forwards operations to [base].
   const DelegatingIterable(Iterable<E> base) : _base = base;
 }
 
 
-/**
- * Creates a [List] that delegates all operations to a base list.
- *
- * This class can be used hide non-`List` methods of a list object,
- * or it can be extended to add extra functionality on top of an existing
- * list object.
- */
+/// Creates a [List] that delegates all operations to a base list.
+///
+/// This class can be used hide non-`List` methods of a list object,
+/// or it can be extended to add extra functionality on top of an existing
+/// list object.
 class DelegatingList<E> extends DelegatingIterable<E> implements List<E> {
   const DelegatingList(List<E> base) : super(base);
 
   List<E> get _listBase => _base;
 
   E operator [](int index) => _listBase[index];
 
   void operator []=(int index, E value) {
     _listBase[index] = value;
   }
@@ skipping 60 matching lines @@
   Iterable<E> get reversed => _listBase.reversed;
 
   void setAll(int index, Iterable<E> iterable) {
     _listBase.setAll(index, iterable);
   }
 
   void setRange(int start, int end, Iterable<E> iterable, [int skipCount = 0]) {
     _listBase.setRange(start, end, iterable, skipCount);
   }
 
-  void shuffle([Random random]) {
+  void shuffle([math.Random random]) {
     _listBase.shuffle(random);
   }
 
   void sort([int compare(E a, E b)]) {
     _listBase.sort(compare);
   }
 
   List<E> sublist(int start, [int end]) => _listBase.sublist(start, end);
 }
 
 
-/**
- * Creates a [Set] that delegates all operations to a base set.
- *
- * This class can be used hide non-`Set` methods of a set object,
- * or it can be extended to add extra functionality on top of an existing
- * set object.
- */
+/// Creates a [Set] that delegates all operations to a base set.
+///
+/// This class can be used hide non-`Set` methods of a set object,
+/// or it can be extended to add extra functionality on top of an existing
+/// set object.
 class DelegatingSet<E> extends DelegatingIterable<E> implements Set<E> {
   const DelegatingSet(Set<E> base) : super(base);
 
   Set<E> get _setBase => _base;
 
   bool add(E value) => _setBase.add(value);
 
   void addAll(Iterable<E> elements) {
     _setBase.addAll(elements);
   }
@@ skipping 26 matching lines @@
 
   void retainWhere(bool test(E element)) {
     _setBase.retainWhere(test);
   }
 
   Set<E> union(Set<E> other) => _setBase.union(other);
 
   Set<E> toSet() => new DelegatingSet<E>(_setBase.toSet());
 }
 
-/**
- * Creates a [Queue] that delegates all operations to a base queue.
- *
- * This class can be used hide non-`Queue` methods of a queue object,
- * or it can be extended to add extra functionality on top of an existing
- * queue object.
- */
+/// Creates a [Queue] that delegates all operations to a base queue.
+///
+/// This class can be used hide non-`Queue` methods of a queue object,
+/// or it can be extended to add extra functionality on top of an existing
+/// queue object.
 class DelegatingQueue<E> extends DelegatingIterable<E> implements Queue<E> {
   const DelegatingQueue(Queue<E> queue) : super(queue);
 
   Queue<E> get _baseQueue => _base;
 
   void add(E value) {
     _baseQueue.add(value);
   }
 
   void addAll(Iterable<E> iterable) {
@@ skipping 16 matching lines @@
 
   void removeWhere(bool test(E element)) { _baseQueue.removeWhere(test); }
 
   void retainWhere(bool test(E element)) { _baseQueue.retainWhere(test); }
 
   E removeFirst() => _baseQueue.removeFirst();
 
   E removeLast() => _baseQueue.removeLast();
 }
 
-/**
- * Creates a [Map] that delegates all operations to a base map.
- *
- * This class can be used hide non-`Map` methods of an object that extends
- * `Map`, or it can be extended to add extra functionality on top of an existing
- * map object.
- */
+/// Creates a [Map] that delegates all operations to a base map.
+///
+/// This class can be used hide non-`Map` methods of an object that extends
+/// `Map`, or it can be extended to add extra functionality on top of an
+/// existing map object.
 class DelegatingMap<K, V> implements Map<K, V> {
   final Map<K, V> _base;
 
   const DelegatingMap(Map<K, V> base) : _base = base;
 
   V operator [](Object key) => _base[key];
 
   void operator []=(K key, V value) {
     _base[key] = value;
   }
@@ skipping 24 matching lines @@
 
   V putIfAbsent(K key, V ifAbsent()) => _base.putIfAbsent(key, ifAbsent);
 
   V remove(Object key) => _base.remove(key);
 
   Iterable<V> get values => _base.values;
 
   String toString() => _base.toString();
 }
 
-/**
- * An unmodifiable [Set] view of the keys of a [Map].
- *
- * The set delegates all operations to the underlying map.
- *
- * A `Map` can only contain each key once, so its keys can always
- * be viewed as a `Set` without any loss, even if the [Map.keys]
- * getter only shows an [Iterable] view of the keys.
- *
- * Note that [lookup] is not supported for this set.
- */
+/// An unmodifiable [Set] view of the keys of a [Map].
+///
+/// The set delegates all operations to the underlying map.
+///
+/// A `Map` can only contain each key once, so its keys can always
+/// be viewed as a `Set` without any loss, even if the [Map.keys]
+/// getter only shows an [Iterable] view of the keys.
+///
+/// Note that [lookup] is not supported for this set.
 class MapKeySet<E> extends _DelegatingIterableBase<E>
     with UnmodifiableSetMixin<E> {
   final Map<E, dynamic> _baseMap;
 
   MapKeySet(Map<E, dynamic> base) : _baseMap = base;
 
   Iterable<E> get _base => _baseMap.keys;
 
   bool contains(Object element) => _baseMap.containsKey(element);
 
   bool get isEmpty => _baseMap.isEmpty;
 
   bool get isNotEmpty => _baseMap.isNotEmpty;
 
   int get length => _baseMap.length;
 
   String toString() => "{${_base.join(', ')}}";
 
   bool containsAll(Iterable<Object> other) => other.every(contains);
 
-  /**
-   * Returns a new set with the the elements of [this] that are not in [other].
-   *
-   * That is, the returned set contains all the elements of this [Set] that are
-   * not elements of [other] according to `other.contains`.
-   *
-   * Note that the returned set will use the default equality operation, which
-   * may be different than the equality operation [this] uses.
-   */
+  /// Returns a new set with the the elements of [this] that are not in [other].
+  ///
+  /// That is, the returned set contains all the elements of this [Set] that are
+  /// not elements of [other] according to `other.contains`.
+  ///
+  /// Note that the returned set will use the default equality operation, which
+  /// may be different than the equality operation [this] uses.
   Set<E> difference(Set<E> other) =>
       where((element) => !other.contains(element)).toSet();
 
-  /**
-   * Returns a new set which is the intersection between [this] and [other].
-   *
-   * That is, the returned set contains all the elements of this [Set] that are
-   * also elements of [other] according to `other.contains`.
-   *
-   * Note that the returned set will use the default equality operation, which
-   * may be different than the equality operation [this] uses.
-   */
+  /// Returns a new set which is the intersection between [this] and [other].
+  ///
+  /// That is, the returned set contains all the elements of this [Set] that are
+  /// also elements of [other] according to `other.contains`.
+  ///
+  /// Note that the returned set will use the default equality operation, which
+  /// may be different than the equality operation [this] uses.
   Set<E> intersection(Set<Object> other) => where(other.contains).toSet();
 
-  /**
-   * Throws an [UnsupportedError] since there's no corresponding method for
-   * [Map]s.
-   */
+  /// Throws an [UnsupportedError] since there's no corresponding method for
+  /// [Map]s.
   E lookup(E element) => throw new UnsupportedError(
       "MapKeySet doesn't support lookup().");
 
-  /**
-   * Returns a new set which contains all the elements of [this] and [other].
-   *
-   * That is, the returned set contains all the elements of this [Set] and all
-   * the elements of [other].
-   *
-   * Note that the returned set will use the default equality operation, which
-   * may be different than the equality operation [this] uses.
-   */
+  /// Returns a new set which contains all the elements of [this] and [other].
+  ///
+  /// That is, the returned set contains all the elements of this [Set] and all
+  /// the elements of [other].
+  ///
+  /// Note that the returned set will use the default equality operation, which
+  /// may be different than the equality operation [this] uses.
   Set<E> union(Set<E> other) => toSet()..addAll(other);
 }
 
-/**
- * Creates a modifiable [Set] view of the values of a [Map].
- * 
- * The `Set` view assumes that the keys of the `Map` can be uniquely determined
- * from the values. The `keyForValue` function passed to the constructor finds
- * the key for a single value. The `keyForValue` function should be consistent
- * with equality. If `value1 == value2` then `keyForValue(value1)` and
- * `keyForValue(value2)` should be considered equal keys by the underlying map,
- * and vice versa.
- *
- * Modifying the set will modify the underlying map based on the key returned by
- * `keyForValue`.
- *
- * If the `Map` contents are not compatible with the `keyForValue` function, the
- * set will not work consistently, and may give meaningless responses or do
- * inconsistent updates.
- *
- * This set can, for example, be used on a map from database record IDs to the
- * records. It exposes the records as a set, and allows for writing both
- * `recordSet.add(databaseRecord)` and `recordMap[id]`.
- *
- * Effectively, the map will act as a kind of index for the set.
- */
+/// Creates a modifiable [Set] view of the values of a [Map].
+/// 
+/// The `Set` view assumes that the keys of the `Map` can be uniquely determined
+/// from the values. The `keyForValue` function passed to the constructor finds
+/// the key for a single value. The `keyForValue` function should be consistent
+/// with equality. If `value1 == value2` then `keyForValue(value1)` and
+/// `keyForValue(value2)` should be considered equal keys by the underlying map,
+/// and vice versa.
+///
+/// Modifying the set will modify the underlying map based on the key returned
+/// by `keyForValue`.
+///
+/// If the `Map` contents are not compatible with the `keyForValue` function,
+/// the set will not work consistently, and may give meaningless responses or do
+/// inconsistent updates.
+///
+/// This set can, for example, be used on a map from database record IDs to the
+/// records. It exposes the records as a set, and allows for writing both
+/// `recordSet.add(databaseRecord)` and `recordMap[id]`.
+///
+/// Effectively, the map will act as a kind of index for the set.
 class MapValueSet<K, V> extends _DelegatingIterableBase<V> implements Set<V> {
   final Map<K, V> _baseMap;
   final Function _keyForValue;
 
-  /**
-   * Creates a new [MapValueSet] based on [base].
-   *
-   * [keyForValue] returns the key in the map that should be associated with the
-   * given value. The set's notion of equality is identical to the equality of
-   * the return values of [keyForValue].
-   */
+  /// Creates a new [MapValueSet] based on [base].
+  ///
+  /// [keyForValue] returns the key in the map that should be associated with
+  /// the given value. The set's notion of equality is identical to the equality
+  /// of the return values of [keyForValue].
   MapValueSet(Map<K, V> base, K keyForValue(V value))
       : _baseMap = base,
         _keyForValue = keyForValue;
 
   Iterable<V> get _base => _baseMap.values;
 
   bool contains(Object element) {
     if (element != null && element is! V) return false;
     return _baseMap.containsKey(_keyForValue(element));
   }
@@ skipping 15 matching lines @@
     });
     return result;
   }
 
   void addAll(Iterable<V> elements) => elements.forEach(add);
 
   void clear() => _baseMap.clear();
 
   bool containsAll(Iterable<Object> other) => other.every(contains);
 
-  /**
-   * Returns a new set with the the elements of [this] that are not in [other].
-   *
-   * That is, the returned set contains all the elements of this [Set] that are
-   * not elements of [other] according to `other.contains`.
-   *
-   * Note that the returned set will use the default equality operation, which
-   * may be different than the equality operation [this] uses.
-   */
+  /// Returns a new set with the the elements of [this] that are not in [other].
+  ///
+  /// That is, the returned set contains all the elements of this [Set] that are
+  /// not elements of [other] according to `other.contains`.
+  ///
+  /// Note that the returned set will use the default equality operation, which
+  /// may be different than the equality operation [this] uses.
   Set<V> difference(Set<V> other) =>
       where((element) => !other.contains(element)).toSet();
 
-  /**
-   * Returns a new set which is the intersection between [this] and [other].
-   *
-   * That is, the returned set contains all the elements of this [Set] that are
-   * also elements of [other] according to `other.contains`.
-   *
-   * Note that the returned set will use the default equality operation, which
-   * may be different than the equality operation [this] uses.
-   */
+  /// Returns a new set which is the intersection between [this] and [other].
+  ///
+  /// That is, the returned set contains all the elements of this [Set] that are
+  /// also elements of [other] according to `other.contains`.
+  ///
+  /// Note that the returned set will use the default equality operation, which
+  /// may be different than the equality operation [this] uses.
   Set<V> intersection(Set<Object> other) => where(other.contains).toSet();
 
   V lookup(Object element) => _baseMap[_keyForValue(element)];
 
   bool remove(Object value) {
     if (value != null && value is! V) return false;
     var key = _keyForValue(value);
     if (!_baseMap.containsKey(key)) return false;
     _baseMap.remove(key);
     return true;
@@ skipping 21 matching lines @@
     var keysToRemove = [];
     _baseMap.forEach((k, v) {
       if (!valuesToRetain.contains(v)) keysToRemove.add(k);
     });
     keysToRemove.forEach(_baseMap.remove);
   }
 
   void retainWhere(bool test(V element)) =>
       removeWhere((element) => !test(element));
 
-  /**
-   * Returns a new set which contains all the elements of [this] and [other].
-   *
-   * That is, the returned set contains all the elements of this [Set] and all
-   * the elements of [other].
-   *
-   * Note that the returned set will use the default equality operation, which
-   * may be different than the equality operation [this] uses.
-   */
+  /// Returns a new set which contains all the elements of [this] and [other].
+  ///
+  /// That is, the returned set contains all the elements of this [Set] and all
+  /// the elements of [other].
+  ///
+  /// Note that the returned set will use the default equality operation, which
+  /// may be different than the equality operation [this] uses.
   Set<V> union(Set<V> other) => toSet()..addAll(other);
 }