OpenHarmony語言基礎類庫【@ohos.util.HashMap (非線性容器HashMap)】

HashMap底層使用數組+鏈表+紅黑樹的方式實現，查詢、插入和刪除的效率都很高。HashMap存儲內容基于key-value的鍵值對映射，不能有重復的key，且一個key只能對應一個value。

HashMap和[TreeMap]相比，HashMap依據鍵的hashCode存取數據，訪問速度較快。而TreeMap是有序存取，效率較低。

[HashSet]基于HashMap實現。HashMap的輸入參數由key、value兩個值組成。在HashSet中，只對value對象進行處理。

推薦使用場景： 需要快速存取、刪除以及插入鍵值對數據時，推薦使用HashMap。

文檔中存在泛型的使用，涉及以下泛型標記符：

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

說明：

本模塊首批接口從API version 8開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。
鴻蒙開發指導文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]點擊或者復制轉到。

導入模塊

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

HashMap

屬性

系統能力： SystemCapability.Utils.Lang

constructor

constructor()

HashMap的構造函數。

系統能力： SystemCapability.Utils.Lang

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

let hashMap = new HashMap();

isEmpty

isEmpty(): boolean

判斷該HashMap是否為空。

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

const hashMap = new HashMap();
let result = hashMap.isEmpty();

hasKey

hasKey(key: K): boolean

判斷此HashMap中是否含有該指定key。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

let hashMap = new HashMap();
hashMap.set("squirrel", 123);
let result = hashMap.hasKey("squirrel");

hasValue

hasValue(value: V): boolean

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

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

let hashMap = new HashMap();
hashMap.set("squirrel", 123);
let result = hashMap.hasValue(123);

get

get(key: K): V

獲取指定key所對應的value，不存在返回undefined。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

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

setAll

setAll(map: HashMap): void

將一個HashMap中的所有元素組添加到另一個hashMap中。

系統能力： SystemCapability.Utils.Lang

參數：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

let hashMap = new HashMap();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
let newHashMap = new HashMap();
newHashMap.set("newMap", 99);
hashMap.setAll(newHashMap);

set

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

向HashMap中添加或更新一組數據。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

let hashMap = new HashMap();
let result = hashMap.set("squirrel", 123);

remove

remove(key: K): V

刪除指定key所對應元素。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

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

clear

clear(): void

清除HashMap中的所有元素，并把length置為0。

系統能力： SystemCapability.Utils.Lang

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

let hashMap = new HashMap();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
hashMap.clear();

keys

keys(): IterableIterator

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

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

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

values

values(): IterableIterator

返回包含此映射中包含的鍵對應的值的新迭代器對象。

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

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

replace

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

對HashMap中一組數據進行更新（替換）。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

let hashMap = new HashMap();
hashMap.set("sparrow", 123);
let result = hashMap.replace("sparrow", 357);

forEach

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

通過回調函數來遍歷HashMap實例對象上的元素以及元素對應的下標。

系統能力： SystemCapability.Utils.Lang

參數：

callbackfn的參數說明：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

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

entries

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

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

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

let hashMap = new HashMap();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);
let iter = hashMap.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 hashMap = new HashMap();
hashMap.set("squirrel", 123);
hashMap.set("sparrow", 356);

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

// 使用方法二：
 let iter = hashMap[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();
 }

審核編輯 黃宇