OpenHarmony语言基础类库【@ohos.util.LightWeightMap (非线性容器LightWeightMap)】

jf_46214456 2024-04-26 941

电子说

1.3w人已加入

描述

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

LightWeightMap依据泛型定义，采用轻量级结构，初始默认容量大小为8，每次扩容大小为原始容量的两倍。

集合中key值的查找依赖于hash算法，通过一个数组存储hash值，然后映射到其他数组中的key值及value值。

LightWeightMap和[HashMap]都是用来存储键值对的集合，LightWeightMap占用内存更小。

推荐使用场景： 当需要存取key-value键值对时，推荐使用占用内存更小的LightWeightMap。

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

  • K：Key，键
  • V：Value，值

说明：

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

导入模块

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

LightWeightMap

属性

系统能力： SystemCapability.Utils.Lang

名称类型可读可写说明
lengthnumber是否LightWeightMap的元素个数。

鸿蒙开发指导文档：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]点击或者复制转到。

constructor

constructor()

LightWeightMap的构造函数。

系统能力： SystemCapability.Utils.Lang

错误码：

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

错误码ID错误信息
10200012The LightWeightMap's constructor cannot be directly invoked.

示例：

let lightWeightMap = new LightWeightMap();

isEmpty

isEmpty(): boolean

判断该LightWeightMap是否为空。

系统能力： SystemCapability.Utils.Lang

返回值：

类型说明
boolean为空返回true，不为空返回false。

错误码：

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

错误码ID错误信息
10200011The isEmpty method cannot be bound.

示例：

const lightWeightMap = new LightWeightMap();
let result = lightWeightMap.isEmpty();

hasAll

hasAll(map: LightWeightMap): boolean

判断此LightWeightMap中是否含有该指定map中的所有元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
mapLightWeightMap是比较对象。

返回值：

类型说明
boolean包含所有元素返回true，否则返回false。

错误码：

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

错误码ID错误信息
10200011The hasAll method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let map = new LightWeightMap();
map.set("sparrow", 356);
let result = lightWeightMap.hasAll(map);

hasKey

hasKey(key: K): boolean

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

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
keyK是指定key。

返回值：

类型说明
boolean包含指定key返回true，否则返回false。

错误码：

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

错误码ID错误信息
10200011The hasKey method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
let result = lightWeightMap.hasKey("squirrel");

hasValue

hasValue(value: V): boolean

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

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
valueV是指定元素。

返回值：

类型说明
boolean包含指定元素返回true，否则返回false。

错误码：

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

错误码ID错误信息
10200011The hasValue method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
let result = lightWeightMap.hasValue(123);

increaseCapacityTo

increaseCapacityTo(minimumCapacity: number): void

将当前LightWeightMap扩容至可以容纳指定数量元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
minimumCapacitynumber是需要容纳的数量。

错误码：

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

错误码ID错误信息
10200011The increaseCapacityTo method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.increaseCapacityTo(10);

get

get(key: K): V

获取指定key所对应的value。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
keyK是指定key。

返回值：

类型说明
V返回key映射的value值。

错误码：

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

错误码ID错误信息
10200011The get method cannot be bound.

示例：

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

getIndexOfKey

getIndexOfKey(key: K): number

查找key元素第一次出现的下标值，如果没有找到该元素返回-1。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
keyK是被查找的元素。

返回值：

类型说明
number返回key元素第一次出现时的下标值，查找失败返回-1。

错误码：

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

错误码ID错误信息
10200011The getIndexOfKey method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let result = lightWeightMap.getIndexOfKey("sparrow");

getIndexOfValue

getIndexOfValue(value: V): number

查找value元素第一次出现的下标值，如果没有找到该元素返回-1。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
valueV是被查找的元素。

返回值：

类型说明
number返回value元素第一次出现时的下标值，查找失败返回-1。

错误码：

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

错误码ID错误信息
10200011The getIndexOfValue method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let result = lightWeightMap.getIndexOfValue(123);

getKeyAt

getKeyAt(index: number): K

查找指定下标的元素键值对中key值，否则返回undefined。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
indexnumber是所查找的下标。

返回值：

类型说明
K返回该下标对应的元素键值对中key值。

错误码：

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

错误码ID错误信息
10200011The getKeyAt method cannot be bound.
10200001The value of index is out of range.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let result = lightWeightMap.getKeyAt(1);

setAll

setAll(map: LightWeightMap): void

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

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
mapLightWeightMap是被添加元素的lightWeightMap。

错误码：

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

错误码ID错误信息
10200011The setAll method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let map = new LightWeightMap();
map.setAll(lightWeightMap); // 将lightWeightMap中所有的元素添加到map中

set

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

向LightWeightMap中添加或更新一组数据。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
keyK是添加成员数据的键名。
valueV是添加成员数据的值。

返回值：

类型说明
Object返回添加数据后的lightWeightMap。

错误码：

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

错误码ID错误信息
10200011The set method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
let result = lightWeightMap.set("squirrel", 123);

remove

remove(key: K): V

删除并返回指定key映射的元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
keyK是指定key。

返回值：

类型说明
V返回删除元素的值。

错误码：

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

错误码ID错误信息
10200011The remove method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
lightWeightMap.remove("sparrow");

removeAt

removeAt(index: number): boolean

删除指定下标对应的元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
indexnumber是指定下标。

返回值：

类型说明
boolean成功删除元素返回true，否则返回false。

错误码：

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

错误码ID错误信息
10200011The removeAt method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let result = lightWeightMap.removeAt(1);

setValueAt

setValueAt(index: number, newValue: V): boolean

替换指定下标对应键值对中的元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
indexnumber是指定下标。
newValueV是替换键值对中的值。

返回值：

类型说明
boolean成功替换指定位置数据返回true，否则返回false。

错误码：

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

错误码ID错误信息
10200011The setValueAt method cannot be bound.
10200001The value of index is out of range.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
lightWeightMap.setValueAt(1, 3546);

getValueAt

getValueAt(index: number): V

获取指定下标对应键值对中的元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
indexnumber是指定下标。

返回值：

类型说明
V返回指定下标对应键值对中的元素。

错误码：

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

错误码ID错误信息
10200011The getValueAt method cannot be bound.
10200001The value of index is out of range.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let result = lightWeightMap.getValueAt(1);

clear

clear(): void

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

系统能力： SystemCapability.Utils.Lang

错误码：

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

错误码ID错误信息
10200011The clear method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
lightWeightMap.clear();

keys

keys(): IterableIterator

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

系统能力： SystemCapability.Utils.Lang

返回值：

类型说明
IterableIterator返回一个迭代器。

错误码：

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

错误码ID错误信息
10200011The keys method cannot be bound.

示例：

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

values

values(): IterableIterator

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

系统能力： SystemCapability.Utils.Lang

返回值：

类型说明
IterableIterator返回一个迭代器。

错误码：

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

错误码ID错误信息
10200011The values method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let iter = lightWeightMap.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?: LightWeightMap) => void, thisArg?: Object): void

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

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
callbackFnfunction是回调函数。
thisArgObject否callbackfn被调用时用作this值。

callbackfn的参数说明：

参数名类型必填说明
valueV否当前遍历到的元素键值对的值。
keyK否当前遍历到的元素键值对的键。
mapLightWeightMap否当前调用forEach方法的实例对象。

错误码：

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

错误码ID错误信息
10200011The forEach method cannot be bound.

示例：

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

entries

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

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

系统能力： SystemCapability.Utils.Lang

返回值：

类型说明
IterableIterator<[K, V]>返回一个迭代器。

错误码：

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

错误码ID错误信息
10200011The entries method cannot be bound.

示例：

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

toString

toString(): String

将此映射中包含的键值对拼接成字符串，并返回字符串类型。

系统能力： SystemCapability.Utils.Lang

返回值：

类型说明
String返回一个字符串。

错误码：

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

错误码ID错误信息
10200011The toString method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let result = lightWeightMap.toString();

[Symbol.iterator]

HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿

鸿蒙

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

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

系统能力： SystemCapability.Utils.Lang

返回值：

类型说明
IterableIterator<[K, V]>返回一个迭代器。

错误码：

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

错误码ID错误信息
10200011The Symbol.iterator method cannot be bound.

示例：

let lightWeightMap = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);

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

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

审核编辑 黄宇

打开APP阅读更多精彩内容
声明：本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人，不代表电子发烧友网立场。文章及其配图仅供工程师学习之用，如有内容侵权或者其他违规问题，请联系本站处理。 举报投诉

全部0条评论

快来发表一下你的评论吧 !

下载APP
|投诉反馈|电子发烧友网
© 2021 elecfans.com
湘ICP备2023018690号
×
20
完善资料，
赚取积分