非线性容器TreeMap

2024-01-23 18:17 更新

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

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

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

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

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

  • K: Key, 键

  • V: Value, 值

说明

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

导入模块

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

TreeMap

属性

系统能力: SystemCapability.Utils.Lang

名称

类型

可读

可写

说明

length

number

TreeMap的元素个数。

constructor

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

TreeMap的构造函数。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

comparator

function

用户自定义的比较函数。

错误码:

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

错误码ID

错误信息

10200012

The TreeMap's constructor cannot be directly invoked.

示例:

  1. let treeMap = new TreeMap();

isEmpty

isEmpty(): boolean

判断该容器是否为空。

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

boolean

为空返回true,否则返回false。

错误码:

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

错误码ID

错误信息

10200011

The isEmpty method cannot be bound.

示例:

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

hasKey

hasKey(key: K): boolean

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

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

指定key

返回值:

类型

说明

boolean

包含指定key返回true,否则返回false。

错误码:

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

错误码ID

错误信息

10200011

The hasKey method cannot be bound.

示例:

  1. let treeMap = new TreeMap();
  2. let result = treeMap.hasKey("squirrel");
  3. treeMap.set("squirrel", 123);
  4. let result1 = treeMap.hasKey("squirrel");

hasValue

hasValue(value: V): boolean

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

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

value

V

指定value。

返回值:

类型

说明

boolean

包含指定元素返回true,否则返回false。

错误码:

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

错误码ID

错误信息

10200011

The hasValue method cannot be bound.

示例:

  1. let treeMap = new TreeMap();
  2. let result = treeMap.hasValue(123);
  3. treeMap.set("squirrel", 123);
  4. let result1 = treeMap.hasValue(123);

get

get(key: K): V

获取指定key所对应的value。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

指定key。

返回值:

类型

说明

V

返回key映射的value值。

错误码:

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

错误码ID

错误信息

10200011

The get method cannot be bound.

示例:

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

getFirstKey

getFirstKey(): K

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

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

K

返回排序第一的key。

错误码:

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

错误码ID

错误信息

10200011

The getFirstKey method cannot be bound.

示例:

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

getLastKey

getLastKey(): K

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

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

K

返回排序最后的key

错误码:

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

错误码ID

错误信息

10200011

The getLastKey method cannot be bound.

示例:

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

setAll

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

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

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

map

TreeMap<K, V>

该map会添加到其调用setAll接口的map对象中。

错误码:

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

错误码ID

错误信息

10200011

The setAll method cannot be bound.

示例:

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

set

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

向容器中添加一组数据。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

添加成员数据的键名。

value

V

添加成员数据的值。

返回值:

类型

说明

Object

返回添加后的treeMap

错误码:

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

错误码ID

错误信息

10200011

The set method cannot be bound.

示例:

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

remove

remove(key: K): V

删除指定key对应的元素。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

指定key。

返回值:

类型

说明

V

返回删除元素的值。

错误码:

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

错误码ID

错误信息

10200011

The remove method cannot be bound.

示例:

  1. let treeMap = new TreeMap();
  2. treeMap.set("squirrel", 123);
  3. treeMap.set("sparrow", 356);
  4. treeMap.remove("sparrow");

getLowerKey

getLowerKey(key: K): K

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

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

对比的key值。

返回值:

类型

说明

K

返回排序中key前一位的数据。

错误码:

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

错误码ID

错误信息

10200011

The getLowerKey method cannot be bound.

示例:

  1. let treeMap = new TreeMap();
  2. treeMap.set("squirrel", 123);
  3. treeMap.set("sparrow", 356);
  4. treeMap.set("gander", 356);
  5. let result = treeMap.getLowerKey("sparrow");

getHigherKey

getHigherKey(key: K): K

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

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

对比的key值。

返回值:

类型

说明

K

返回排序中key后一位的数据。

错误码:

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

错误码ID

错误信息

10200011

The getHigherKey method cannot be bound.

示例:

  1. let treeMap = new TreeMap();
  2. treeMap.set("squirrel", 123);
  3. treeMap.set("sparrow", 356);
  4. treeMap.set("gander", 356);
  5. let result = treeMap.getHigherKey("sparrow");

replace

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

对容器中一组数据进行更新(替换)。

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

key

K

指定key。

newValue

V

替换的元素。

返回值:

类型

说明

boolean

对指定key对应的元素替换成功返回true,否则返回false。

错误码:

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

错误码ID

错误信息

10200011

The replace method cannot be bound.

示例:

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

clear

clear(): void

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

系统能力: SystemCapability.Utils.Lang

错误码:

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

错误码ID

错误信息

10200011

The clear method cannot be bound.

示例:

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

keys

keys(): IterableIterator<K>

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

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

IterableIterator<K>

返回一个迭代器。

错误码:

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

错误码ID

错误信息

10200011

The keys method cannot be bound.

示例:

  1. let treeMap = new TreeMap();
  2. treeMap.set("squirrel", 123);
  3. treeMap.set("sparrow", 356);
  4. let iter = treeMap.keys();
  5. let temp = iter.next().value;
  6. while(temp != undefined) {
  7. console.log("value:" + temp);
  8. temp = iter.next().value;
  9. }

values

values(): IterableIterator<V>

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

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

IterableIterator<V>

返回一个迭代器。

错误码:

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

错误码ID

错误信息

10200011

The values method cannot be bound.

示例:

  1. let treeMap = new TreeMap();
  2. treeMap.set("squirrel", 123);
  3. treeMap.set("sparrow", 356);
  4. let iter = treeMap.values();
  5. let temp = iter.next().value;
  6. while(temp != undefined) {
  7. console.log("value:" + temp);
  8. temp = iter.next().value;
  9. }

forEach

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

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

系统能力: SystemCapability.Utils.Lang

参数:

参数名

类型

必填

说明

callbackFn

function

回调函数。

thisArg

Object

callbackFn被调用时用作this值。

callbackFn的参数说明:

参数名

类型

必填

说明

value

V

当前遍历到的元素键值对的值。

key

K

当前遍历到的元素键值对的键。

map

TreeMap<K, V>

当前调用forEach方法的实例对象。

错误码:

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

错误码ID

错误信息

10200011

The forEach method cannot be bound.

示例:

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

entries

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

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

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

IterableIterator<[K, V]>

返回一个迭代器。

错误码:

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

错误码ID

错误信息

10200011

The entries method cannot be bound.

示例:

  1. let treeMap = new TreeMap();
  2. treeMap.set("squirrel", 123);
  3. treeMap.set("sparrow", 356);
  4. let iter = treeMap.entries();
  5. let temp = iter.next().value;
  6. while(temp != undefined) {
  7. console.log("key:" + temp[0]);
  8. console.log("value:" + temp[1]);
  9. temp = iter.next().value;
  10. }

[Symbol.iterator]

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

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

系统能力: SystemCapability.Utils.Lang

返回值:

类型

说明

IterableIterator<[K, V]>

返回一个迭代器。

错误码:

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

错误码ID

错误信息

10200011

The Symbol.iterator method cannot be bound.

示例:

  1. let treeMap = new TreeMap();
  2. treeMap.set("squirrel", 123);
  3. treeMap.set("sparrow", 356);
  4. // 使用方法一:
  5. for (let item of treeMap) {
  6. console.log("key:" + item[0]);
  7. console.log("value:" + item[1]);
  8. }
  9. // 使用方法二:
  10. let iter = treeMap[Symbol.iterator]();
  11. let temp = iter.next().value;
  12. while(temp != undefined) {
  13. console.log("key:" + temp[0]);
  14. console.log("value:" + temp[1]);
  15. temp = iter.next().value;
  16. }
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号