SplayTreeMap<K, V> 类 final

一个可以按顺序相互比较的对象的 Map。

该映射基于自平衡的二叉树。它允许大多数单个条目操作在摊销对数时间内完成。

映射的键使用在构造函数中传入的 compare 函数进行比较，用于排序和相等性。如果映射只包含键 a，那么当 compare(a, b) == 0 时，map.containsKey(b) 将返回 true，并且不会检查 a == b 的值。如果省略比较函数，则假设对象是 Comparable，并使用它们的 Comparable.compareTo 方法进行比较。在这种情况下，不可比较的对象（包括 null）不能作为键。

为了允许使用不支持 compare 函数的对象调用 operator []、remove 或 containsKey，可以提供一个额外的 isValidKey 断言函数。此函数在 compare 函数用于可能不是 K 值的参数值之前进行测试。如果省略，则 isValidKey 函数默认为测试值是否为 K。

注意：在执行操作（例如在 forEach 或 putIfAbsent 调用期间调用的函数中）时，不要修改映射（添加或删除键），或在对映射进行迭代时（keys、values 或 entries）。

示例

final planetsByMass = SplayTreeMap<double, String>((a, b) => a.compareTo(b));

要将数据添加到映射中，请使用 operator[]、addAll 或 addEntries。

planetsByMass[0.06] = 'Mercury';
planetsByMass
    .addAll({0.81: 'Venus', 1.0: 'Earth', 0.11: 'Mars', 317.83: 'Jupiter'});

要检查映射是否为空，请使用 isEmpty 或 isNotEmpty。要查找映射条目的数量，请使用 length。

print(planetsByMass.isEmpty); // false
print(planetsByMass.length); // 5

forEach 方法会为映射的每个键/值条目调用一个函数。

planetsByMass.forEach((key, value) {
  print('$key \t $value');
  // 0.06    Mercury
  // 0.11    Mars
  // 0.81    Venus
  // 1.0     Earth
  // 317.83  Jupiter
});

要检查映射是否具有具有特定键的条目，请使用 containsKey。

final keyOneExists = planetsByMass.containsKey(1.0); // true
final keyFiveExists = planetsByMass.containsKey(5); // false

要检查映射是否具有具有特定值的条目，请使用 containsValue。

final earthExists = planetsByMass.containsValue('Earth'); // true
final plutoExists = planetsByMass.containsValue('Pluto'); // false

要删除具有特定键的条目，请使用 remove。

final removedValue = planetsByMass.remove(1.0);
print(removedValue); // Earth

要同时删除多个条目，基于它们的键和值，请使用 removeWhere。

planetsByMass.removeWhere((key, value) => key <= 1);
print(planetsByMass); // {317.83: Jupiter}

要基于是否存在具有该键的条目，有条件地添加或修改特定键的值，请使用 putIfAbsent 或 update。

planetsByMass.update(1, (v) => '', ifAbsent: () => 'Earth');
planetsByMass.putIfAbsent(317.83, () => 'Another Jupiter');
print(planetsByMass); // {1.0: Earth, 317.83: Jupiter}

要基于现有的键和值更新所有键的值，请使用 updateAll。

planetsByMass.updateAll((key, value) => 'X');
print(planetsByMass); // {1.0: X, 317.83: X}

要删除所有条目并清空映射，请使用 clear。

planetsByMass.clear();
print(planetsByMass.isEmpty); // false
print(planetsByMass); // {}

另请参阅

• Map，键/值对集合的一般接口。
• HashMap 是无序的（迭代顺序没有保证）。
• LinkedHashMap 按键插入顺序迭代。