PlainArray可用于存儲具有關聯關系的key-value鍵值對集合，存儲元素中key值唯一，key值類型為number類型，每個key對應一個value。

PlainArray依據泛型定義，采用輕量級結構，集合中key值的查找依賴于二分查找算法，然后映射到其他數組中的value值。

PlainArray和[LightWeightMap]都是用來存儲鍵值對，且均采用輕量級結構，但PlainArray的key值類型只能為number類型。

推薦使用場景： 當需要存儲key值為number類型的鍵值對時，可以使用PlainArray。

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

• T：Type，類

說明：

本模塊首批接口從API version 8開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

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

PlainArray

鴻蒙開發指導文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

屬性

系統能力： SystemCapability.Utils.Lang

constructor

constructor()

PlainArray的構造函數。

系統能力： SystemCapability.Utils.Lang

錯誤碼：

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

示例：

let plainArray = new PlainArray();

isEmpty

isEmpty(): boolean

判斷該容器是否為空。

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

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

示例：

const plainArray = new PlainArray();
let result = plainArray.isEmpty();

has

has(key: number): boolean

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

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
let result = plainArray.has(1);

get

get(key: number): T

獲取指定key所對應的value。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
let result = plainArray.get(1);

getIndexOfKey

getIndexOfKey(key: number): number

查找指定key對應的下標值，如果沒有找到該key返回-1。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
let result = plainArray.getIndexOfKey(2);

getIndexOfValue

getIndexOfValue(value: T): number

查找指定value元素第一次出現的下標值，如果沒有找到該value元素返回-1。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
let result = plainArray.getIndexOfValue("squirrel");

getKeyAt

getKeyAt(index: number): number

查找指定下標元素鍵值對中的key值。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
let result = plainArray.getKeyAt(1);

getValueAt

getValueAt(index: number): T

查找指定下標元素鍵值對中的Value值，失敗返回undefined。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
let result = plainArray.getValueAt(1);

clone

clone(): PlainArray

克隆一個實例，并返回克隆后的實例。修改克隆后的實例并不會影響原實例。

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
let newPlainArray = plainArray.clone();

add

add(key: number, value: T): void

向容器中添加一組數據。

系統能力： SystemCapability.Utils.Lang

參數：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");

remove

remove(key: number): T

刪除指定key對應的鍵值對。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
let result = plainArray.remove(2);

removeAt

removeAt(index: number): T

刪除指定下標對應的元素。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
let result = plainArray.removeAt(1);

removeRangeFrom

removeRangeFrom(index: number, size: number): number

刪除一定范圍內的元素。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
let result = plainArray.removeRangeFrom(1, 3);

setValueAt

setValueAt(index: number, value: T): void

替換容器中指定下標對應鍵值對中的鍵值。

系統能力： SystemCapability.Utils.Lang

參數：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
plainArray.setValueAt(1, 3546);

toString

toString(): String

獲取包含容器中所有鍵和值的字符串。

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
let result = plainArray.toString();

clear

clear(): void

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

系統能力： SystemCapability.Utils.Lang

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
plainArray.clear();

forEach

forEach(callbackFn: (value: T, index?: number, PlainArray?: PlainArray) => void, thisArg?: Object): void

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

系統能力： SystemCapability.Utils.Lang

參數：

callbackfn的參數說明：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");
plainArray.forEach((value, index) = > {
  console.log("value:" + value, "index:" + index);
});

[Symbol.iterator]

Symbol.iterator: IterableIterator<[number, T]>

返回一個包含key-value鍵值對的迭代器對象，其中key是number類型。

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

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

示例：

let plainArray = new PlainArray();
plainArray.add(1, "squirrel");
plainArray.add(2, "sparrow");

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

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

審核編輯 黃宇