OpenHarmony語(yǔ)言基礎(chǔ)類庫(kù)【@ohos.util.LightWeightMap (非線性容器LightWeightMap)】

LightWeightMap可用于存儲(chǔ)具有關(guān)聯(lián)關(guān)系的key-value鍵值對(duì)集合，存儲(chǔ)元素中key值唯一，每個(gè)key對(duì)應(yīng)一個(gè)value。

LightWeightMap依據(jù)泛型定義，采用輕量級(jí)結(jié)構(gòu)，初始默認(rèn)容量大小為8，每次擴(kuò)容大小為原始容量的兩倍。

集合中key值的查找依賴于hash算法，通過(guò)一個(gè)數(shù)組存儲(chǔ)hash值，然后映射到其他數(shù)組中的key值及value值。

LightWeightMap和[HashMap]都是用來(lái)存儲(chǔ)鍵值對(duì)的集合，LightWeightMap占用內(nèi)存更小。

推薦使用場(chǎng)景： 當(dāng)需要存取key-value鍵值對(duì)時(shí)，推薦使用占用內(nèi)存更小的LightWeightMap。

文檔中存在泛型的使用，涉及以下泛型標(biāo)記符：

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

說(shuō)明：

本模塊首批接口從API version 8開(kāi)始支持。后續(xù)版本的新增接口，采用上角標(biāo)單獨(dú)標(biāo)記接口的起始版本。

導(dǎo)入模塊

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

LightWeightMap

屬性

系統(tǒng)能力： SystemCapability.Utils.Lang

鴻蒙開(kāi)發(fā)指導(dǎo)文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]點(diǎn)擊或者復(fù)制轉(zhuǎn)到。

constructor

constructor()

LightWeightMap的構(gòu)造函數(shù)。

系統(tǒng)能力： SystemCapability.Utils.Lang

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

let lightWeightMap = new LightWeightMap();

isEmpty

isEmpty(): boolean

判斷該LightWeightMap是否為空。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

hasAll

hasAll(map: LightWeightMap): boolean

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

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

hasValue

hasValue(value: V): boolean

判斷此LightWeightMap中是否含有該指定value。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

increaseCapacityTo

increaseCapacityTo(minimumCapacity: number): void

將當(dāng)前LightWeightMap擴(kuò)容至可以容納指定數(shù)量元素。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

get

get(key: K): V

獲取指定key所對(duì)應(yīng)的value。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

getIndexOfKey

getIndexOfKey(key: K): number

查找key元素第一次出現(xiàn)的下標(biāo)值，如果沒(méi)有找到該元素返回-1。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

getIndexOfValue

getIndexOfValue(value: V): number

查找value元素第一次出現(xiàn)的下標(biāo)值，如果沒(méi)有找到該元素返回-1。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

getKeyAt

getKeyAt(index: number): K

查找指定下標(biāo)的元素鍵值對(duì)中key值，否則返回undefined。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

setAll

setAll(map: LightWeightMap): void

將一個(gè)LightWeightMap中的所有元素組添加到另一個(gè)lightWeightMap中。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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中添加或更新一組數(shù)據(jù)。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

remove

remove(key: K): V

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

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

removeAt

removeAt(index: number): boolean

刪除指定下標(biāo)對(duì)應(yīng)的元素。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

setValueAt

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

替換指定下標(biāo)對(duì)應(yīng)鍵值對(duì)中的元素。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

getValueAt

getValueAt(index: number): V

獲取指定下標(biāo)對(duì)應(yīng)鍵值對(duì)中的元素。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

clear

clear(): void

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

系統(tǒng)能力： SystemCapability.Utils.Lang

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

keys

keys(): IterableIterator

返回包含此映射中包含的鍵的新迭代器對(duì)象。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

返回包含此映射中包含的鍵值的新迭代器對(duì)象。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

通過(guò)回調(diào)函數(shù)來(lái)遍歷實(shí)例對(duì)象上的元素以及元素對(duì)應(yīng)的下標(biāo)。

系統(tǒng)能力： SystemCapability.Utils.Lang

參數(shù)：

callbackfn的參數(shù)說(shuō)明：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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]>

返回包含此映射中包含的鍵值對(duì)的新迭代器對(duì)象。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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

將此映射中包含的鍵值對(duì)拼接成字符串，并返回字符串類型。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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]>

返回一個(gè)迭代器，迭代器的每一項(xiàng)都是一個(gè) JavaScript 對(duì)象,并返回該對(duì)象。

系統(tǒng)能力： SystemCapability.Utils.Lang

返回值：

錯(cuò)誤碼：

以下錯(cuò)誤碼的詳細(xì)介紹請(qǐng)參見(jiàn)[語(yǔ)言基礎(chǔ)類庫(kù)錯(cuò)誤碼]。

示例：

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;
}

審核編輯 黃宇