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

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

constructor

constructor()

LightWeightMap的构造函数。

系统能力： SystemCapability.Utils.Lang

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();

isEmpty

isEmpty(): boolean

判断该LightWeightMap是否为空。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

const lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
let result = lightWeightMap.isEmpty();

hasAll

hasAll(map: LightWeightMap<K, V>): boolean

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

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let map: LightWeightMap<string, number> = new LightWeightMap();
map.set("sparrow", 356);
let result = lightWeightMap.hasAll(map);

hasKey

hasKey(key: K): boolean

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

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
let result = lightWeightMap.hasKey("squirrel");

hasValue

hasValue(value: V): boolean

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

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
let result = lightWeightMap.hasValue(123);

increaseCapacityTo

increaseCapacityTo(minimumCapacity: number): void

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

系统能力： SystemCapability.Utils.Lang

参数：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.increaseCapacityTo(10);

get

get(key: K): V

获取指定key所对应的value。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = 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

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = 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

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = 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

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let result = lightWeightMap.getKeyAt(1);

setAll

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

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

系统能力： SystemCapability.Utils.Lang

参数：

错误码：

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

示例：

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

set

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

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

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
let result = lightWeightMap.set("squirrel", 123);

remove

remove(key: K): V

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

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
lightWeightMap.remove("sparrow");

removeAt

removeAt(index: number): boolean

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

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = 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

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
lightWeightMap.setValueAt(1, 3546);

getValueAt

getValueAt(index: number): V

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

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let result = lightWeightMap.getValueAt(1);

clear

clear(): void

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

系统能力： SystemCapability.Utils.Lang

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
lightWeightMap.clear();

keys

keys(): IterableIterator<K>

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

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

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

values

values(): IterableIterator<V>

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

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let iter = lightWeightMap.values();
let temp: IteratorResult<number> = iter.next();
while(!temp.done) {
  console.log("value:" + temp.value);
  temp = iter.next();
}

forEach

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

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

系统能力： SystemCapability.Utils.Lang

参数：

callbackfn的参数说明：

错误码：

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

示例：

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

entries

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

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

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

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

toString

toString(): String

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

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);
let result = lightWeightMap.toString();

[Symbol.iterator]

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

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

说明：

本接口不支持在.ets文件中使用

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

let lightWeightMap: LightWeightMap<string, number> = new LightWeightMap();
lightWeightMap.set("squirrel", 123);
lightWeightMap.set("sparrow", 356);

// 使用方法一：
let nums = Array.from(lightWeightMap.values());
for (let item1 of nums) {
  console.log("value:" + item1);
}

let key = Array.from(lightWeightMap.keys());
for (let item2 of key) {
  console.log("key:" + item2);
}

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