@ohos.util.TreeMap (非线性容器TreeMap)

TreeMap可用于存储具有关联关系的key-value键值对集合，存储元素中key值唯一，每个key对应一个value。

TreeMap底层使用红黑树实现，可以利用二叉树特性快速查找键值对。key值有序存储，可以实现快速的插入和删除。

TreeMap和HashMap相比，HashMap依据键的hashCode存取数据，访问速度较快。而TreeMap是有序存取，效率较低。

推荐使用场景： 一般需要存储有序键值对的场景，可以使用TreeMap。

文档中存在泛型的使用，涉及以下泛型标记符：

• K：Key，键

• V：Value，值

说明：

本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import TreeMap from '@ohos.util.TreeMap';  

TreeMap

属性

系统能力： SystemCapability.Utils.Lang

constructor

constructor(comparator?:(firstValue: K, secondValue: K) => boolean)

TreeMap的构造函数。

系统能力： SystemCapability.Utils.Lang

参数：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();

isEmpty

isEmpty(): boolean

判断该容器是否为空。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

const treeMap = new TreeMap();
let result = treeMap.isEmpty();

hasKey

hasKey(key: K): boolean

判断此容器中是否含有该指定key。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
let result = treeMap.hasKey("squirrel");

hasValue

hasValue(value: V): boolean

判断此容器中是否含有该指定value。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
let result = treeMap.hasValue(123);

get

get(key: K): V

获取指定key所对应的value。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let result = treeMap.get("sparrow");

getFirstKey

getFirstKey(): K

获取容器中排序第一的key。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let result = treeMap.getFirstKey();

getLastKey

getLastKey(): K

获取容器中排序最后的key。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let result = treeMap.getLastKey();

setAll

setAll(map: TreeMap<K, V>): void

将一个TreeMap中的所有元素组添加到另一个TreeMap中。

系统能力： SystemCapability.Utils.Lang

参数：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let map = new TreeMap();
map.set("demo", 12);
map.setAll(treeMap); // 将treeMap中的所有元素添加到map中
map.forEach((value, key) => {
  console.log("value" + value, "key" + key); // 打印结果 12 demo、356 sparrow、123 squirrel
})

set

set(key: K, value: V): Object

向容器中添加一组数据。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);

remove

remove(key: K): V

删除指定key对应的元素。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let result = treeMap.remove("sparrow");

getLowerKey

getLowerKey(key: K): K

获取容器中比传入key排序靠前一位的key。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
treeMap.set("gander", 356);
let result = treeMap.getLowerKey("sparrow");

getHigherKey

getHigherKey(key: K): K

获取容器中比传入key排序靠后一位的key。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
treeMap.set("gander", 356);
let result = treeMap.getHigherKey("sparrow");

replace

replace(key: K, newValue: V): boolean

对容器中一组数据进行更新（替换）。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("sparrow", 123);
let result = treeMap.replace("sparrow", 357);

clear

clear(): void

清除容器中的所有元素，并把length置为0。

系统能力： SystemCapability.Utils.Lang

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
treeMap.clear();

keys

keys(): IterableIterator<K>

返回包含此映射中包含的键的新迭代器对象。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let iter = treeMap.keys();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("value:" + temp);
  temp = iter.next().value;
}

values

values(): IterableIterator<V>

返回包含此映射中键值的新迭代器对象。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let iter = treeMap.values();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("value:" + temp);
  temp = iter.next().value;
}

forEach

forEach(callbackFn: (value?: V, key?: K, map?: TreeMap<K, V>) => void, thisArg?: Object): void

通过回调函数来遍历实例对象上的元素以及元素对应的下标。

系统能力： SystemCapability.Utils.Lang

参数：

callbackFn的参数说明：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("sparrow", 123);
treeMap.set("gull", 357);
treeMap.forEach((value, key) => {
    console.log("value:" + value, "key:" + key);
});

entries

entries(): IterableIterator<[K, V]>

返回包含此映射中键值对的新迭代器对象。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let iter = treeMap.entries();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("key:" + temp[0]);
  console.log("value:" + temp[1]);
  temp = iter.next().value;
}

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<[K, V]>

返回一个迭代器，迭代器的每一项都是一个JavaScript对象，并返回该对象。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

以下错误码的详细介绍请参见语言基础类库错误码。

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);

// 使用方法一：
for (let item of treeMap) { 
  console.log("key:" + item[0]);
  console.log("value:" + item[1]);
}

// 使用方法二：
let iter = treeMap[Symbol.iterator]();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("key:" + temp[0]);
  console.log("value:" + temp[1]);
  temp = iter.next().value;
}