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

List底層通過(guò)單向鏈表實(shí)現(xiàn)，每個(gè)節(jié)點(diǎn)有一個(gè)指向后一個(gè)元素的引用。當(dāng)需要查詢?cè)貢r(shí)，必須從頭遍歷，插入、刪除效率高，查詢效率低。List允許元素為null。

List和[LinkedList]相比，LinkedList是雙向鏈表，可以快速地在頭尾進(jìn)行增刪，而List是單向鏈表，無(wú)法雙向操作。

推薦使用場(chǎng)景： 當(dāng)需要頻繁的插入刪除時(shí)，推薦使用List高效操作。

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

• T：Type，類

說(shuō)明：

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

導(dǎo)入模塊

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

List

鴻蒙開(kāi)發(fā)指導(dǎo)文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

屬性

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

HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿

constructor

constructor()

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

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

錯(cuò)誤碼：

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

示例：

let list = new List();

add

add(element: T): boolean

在List尾部插入元素。

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

參數(shù)：

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
let result1 = list.add("a");
let result2 = list.add(1);
let b = [1, 2, 3];
let result3 = list.add(b);
let c = {name : "Dylon", age : "13"};
let result4 = list.add(c);
let result5 = list.add(false);

insert

insert(element: T, index: number): void

在長(zhǎng)度范圍內(nèi)任意位置插入指定元素。

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

參數(shù)：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.insert("A", 0);
list.insert(0, 1);
list.insert(true, 2);

has

has(element: T): boolean

判斷此List中是否含有該指定元素。

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

參數(shù)：

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add("squirrel");
let result = list.has("squirrel");

get

get(index: number): T

根據(jù)下標(biāo)獲取List中的元素。

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

參數(shù)：

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(2);
list.add(1);
list.add(2);
list.add(4);
let result = list.get(2);

getLastIndexOf

getLastIndexOf(element: T): number

查找指定元素最后一次出現(xiàn)的下標(biāo)值，查找失敗返回-1。

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

參數(shù)：

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(2);
list.add(1);
list.add(2);
list.add(4);
let result = list.getLastIndexOf(2);

getIndexOf

getIndexOf(element: T): number

查找指定元素第一次出現(xiàn)的下標(biāo)值，查找失敗返回-1。

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

參數(shù)：

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(2);
list.add(1);
list.add(2);
list.add(4);
let result = list.getIndexOf(2);

equal

equal(obj: Object): boolean

比較指定對(duì)象與此List是否相等。

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

參數(shù)：

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
let obj = new List();
obj.add(2);
obj.add(4);
obj.add(5);
let result = list.equal(obj);

removeByIndex

removeByIndex(index: number): T

根據(jù)元素的下標(biāo)值查找元素，并將其刪除。

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

參數(shù)：

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(2);
list.add(4);
let result = list.removeByIndex(2);

remove

remove(element: T): boolean

刪除查找到的第一個(gè)指定的元素。

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

參數(shù)：

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.remove(2);

replaceAllElements

replaceAllElements(callbackFn: (value: T, index?: number, list?: List) => T, thisArg?: Object): void

用戶操作List中的元素,用操作后的元素替換原元素并返回操作后的元素。

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

參數(shù)：

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

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.replaceAllElements((value) = > {
  // 用戶操作邏輯根據(jù)實(shí)際場(chǎng)景進(jìn)行添加。
  return value;
});

forEach

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

通過(guò)回調(diào)函數(shù)來(lái)遍歷List實(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 list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.forEach((value, index) = > {
    console.log("value:" + value, "index:" + index);
});

sort

sort(comparator: (firstValue: T, secondValue: T) => number): void

對(duì)List中的元素進(jìn)行一個(gè)排序操作。

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

參數(shù)：

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

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.sort((a: number, b: number) = > a - b); // 結(jié)果為升序排列
list.sort((a: number, b: number) = > b - a); // 結(jié)果為降序排列

getSubList

getSubList(fromIndex: number, toIndex: number): List

根據(jù)下標(biāo)截取List中的一段元素，并返回這一段List實(shí)例，包括起始值但不包括終止值。

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

參數(shù)：

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.getSubList(1, 3);

clear

clear(): void

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

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

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.clear();

set

set(index: number, element: T): T

將此 List 中指定位置的元素替換為指定元素。

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

參數(shù)：

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.set(2, "b");

convertToArray

convertToArray(): Array

把當(dāng)前List實(shí)例轉(zhuǎn)換成數(shù)組，并返回轉(zhuǎn)換后的數(shù)組。

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

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.convertToArray();

isEmpty

isEmpty(): boolean

判斷該List是否為空。

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

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.isEmpty();

getFirst

getFirst(): T

獲取List實(shí)例中的第一個(gè)元素。

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

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.getFirst();

getLast

getLast(): T

獲取List實(shí)例中的最后一個(gè)元素。

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

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.getLast();

[Symbol.iterator]

Symbol.iterator: IterableIterator

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

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

返回值：

錯(cuò)誤碼：

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

示例：

let list = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);

// 使用方法一：
for (let item of list) { 
  console.log("value: " + item); 
}

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

sf