harmony 鸿蒙@ohos.util.List (线性容器List)

2022-08-09 浏览 (821)

@ohos.util.List (线性容器List)

List底层通过单向链表实现，每个节点有一个指向后一个元素的引用。当需要查询元素时，必须从头遍历，插入、删除效率高，查询效率低。List允许元素为null。

List和LinkedList相比，LinkedList是双向链表，可以快速地在头尾进行增删，而List是单向链表，无法双向操作。

推荐使用场景： 当需要频繁的插入删除时，推荐使用List高效操作。

文档中存在泛型的使用，涉及以下泛型标记符：

  • T：Type，类

说明：

本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

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

List

属性

系统能力： SystemCapability.Utils.Lang

名称类型可读可写说明
lengthnumber是否List的元素个数。

constructor

constructor()

List的构造函数。

系统能力： SystemCapability.Utils.Lang

错误码：

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

错误码ID错误信息
10200012The List's constructor cannot be directly invoked.

示例：

let list: List<string|number|boolean|object> = new List();

add

add(element: T): boolean

在List尾部插入元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
elementT是添加进去的元素。

返回值：

类型说明
boolean插入成功返回true，否则返回false。

错误码：

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

错误码ID错误信息
10200011The add method cannot be bound.

示例：

let list: List<string|number|boolean|object> = new List();
let result1 = list.add("a");
let result2 = list.add(1);
let b = [1, 2, 3];
let result3 = list.add(b);
class C {
  name: string = ''
  age: string = ''
}
let c: C = {name : "Dylon", age : "13"};
let result4 = list.add(c);
let result5 = list.add(false);

insert

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

在长度范围内任意位置插入指定元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
elementT是插入元素。
indexnumber是插入的位置索引。

错误码：

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

错误码ID错误信息
10200011The insert method cannot be bound.
10200001The value of index is out of range.

示例：

let list: List<string|number|boolean> = new List();
list.insert("A", 0);
list.insert(0, 1);
list.insert(true, 2);

has

has(element: T): boolean

判断此List中是否含有该指定元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
elementT是指定元素。

返回值：

类型说明
boolean包含指定元素返回true，否则返回false。

错误码：

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

错误码ID错误信息
10200011The has method cannot be bound.

示例：

let list: List<string> = new List();
list.add("squirrel");
let result = list.has("squirrel");

get

get(index: number): T

根据下标获取List中的元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
indexnumber是要查找的下标。

返回值：

类型说明
T根据下标查找到的元素。

错误码：

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

错误码ID错误信息
10200011The get method cannot be bound.

示例：

let list: List<number> = 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

查找指定元素最后一次出现的下标值，查找失败返回-1。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
elementT是指定元素。

返回值：

类型说明
number返回指定元素最后一次出现的下标值，没有找到返回-1。

错误码：

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

错误码ID错误信息
10200011The getLastIndexOf method cannot be bound.

示例：

let list: List<number> = 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

查找指定元素第一次出现的下标值，查找失败返回-1。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
elementT是指定元素。

返回值：

类型说明
number返回第一次找到指定元素的下标，没有找到返回-1。

错误码：

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

错误码ID错误信息
10200011The getIndexOf method cannot be bound.

示例：

let list: List<number> = 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

比较指定对象与此List是否相等。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
objObject是用来比较的对象。

返回值：

类型说明
boolean如果对象与此列表相同返回true，否则返回false。

错误码：

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

错误码ID错误信息
10200011The equal method cannot be bound.

示例：

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

removeByIndex

removeByIndex(index: number): T

根据元素的下标值查找元素，返回元素后将其删除。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
indexnumber是指定元素的下标值。

返回值：

类型说明
T返回删除的元素。

错误码：

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

错误码ID错误信息
10200011The removeByIndex method cannot be bound.
10200001The value of index is out of range.

示例：

let list: List<number> = 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

删除查找到的第一个指定的元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
elementT是指定元素。

返回值：

类型说明
boolean删除成功返回true，否则返回false。

错误码：

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

错误码ID错误信息
10200011The remove method cannot be bound.

示例：

let list: List<number> = 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>) => T, thisArg?: Object): void

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

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
callbackFnfunction是回调函数。
thisArgObject否callbackfn被调用时用作this值，默认值为当前实例对象。

callbackfn的参数说明：

参数名类型必填说明
valueT是当前遍历到的元素。
indexnumber否当前遍历到的下标值，默认值为0。
listList<T>否当前调用replaceAllElements方法的实例对象，默认值为当前实例对象。

错误码：

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

错误码ID错误信息
10200011The replaceAllElements method cannot be bound.

示例：

let list: List<number> = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.replaceAllElements((value: number) => {
  // 用户操作逻辑根据实际场景进行添加。
  return value;
});

forEach

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

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

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
callbackFnfunction是回调函数。
thisArgObject否callbackfn被调用时用作this值，默认值为当前实例对象。

callbackfn的参数说明：

参数名类型必填说明
valueT是当前遍历到的元素。
indexnumber否当前遍历到的下标值，默认值为0。
ListList<T>否当前调用forEach方法的实例对象，默认值为当前实例对象。

错误码：

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

错误码ID错误信息
10200011The forEach method cannot be bound.

示例：

let list: List<number> = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.forEach((value: number, index?: number) => {
  console.log("value:" + value, "index:" + index);
});

sort

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

对List中的元素进行一个排序操作。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
comparatorfunction是回调函数。

comparator的参数说明：

参数名类型必填说明
firstValueT是前一项元素。
secondValueT是后一项元素。

错误码：

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

错误码ID错误信息
10200011The sort method cannot be bound.

示例：

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

getSubList

getSubList(fromIndex: number, toIndex: number): List<T>

根据下标截取List中的一段元素，并返回这一段List实例，包括起始值但不包括终止值。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
fromIndexnumber是起始下标。
toIndexnumber是终止下标。

返回值：

类型说明
List<T>返回List对象实例。

错误码：

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

错误码ID错误信息
10200011The getSubList method cannot be bound.
10200001The value of fromIndex or toIndex is out of range.

示例：

let list: List<number> = 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。

系统能力： SystemCapability.Utils.Lang

错误码：

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

错误码ID错误信息
10200011The clear method cannot be bound.

示例：

let list: List<number> = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
list.clear();

set

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

将此 List 中指定位置的元素替换为指定元素。

系统能力： SystemCapability.Utils.Lang

参数：

参数名类型必填说明
indexnumber是查找的下标值。
elementT是用来替换的元素。

返回值：

类型说明
T返回替换后的元素

错误码：

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

错误码ID错误信息
10200011The set method cannot be bound.
10200001The value of index is out of range.

示例：

let list: List<number|string> = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.set(2, "b");

convertToArray

convertToArray(): Array<T>

把当前List实例转换成数组，并返回转换后的数组。

系统能力： SystemCapability.Utils.Lang

返回值：

类型说明
Array<T>返回转换后的数组。

错误码：

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

错误码ID错误信息
10200011The convertToArray method cannot be bound.

示例：

let list: List<number> = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.convertToArray();

isEmpty

isEmpty(): boolean

判断该List是否为空。

系统能力： SystemCapability.Utils.Lang

返回值：

类型说明
boolean为空返回true，不为空返回false。

错误码：

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

错误码ID错误信息
10200011The isEmpty method cannot be bound.

示例：

let list: List<number> = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.isEmpty();

getFirst

getFirst(): T

获取List实例中的第一个元素。

系统能力： SystemCapability.Utils.Lang

返回值：

类型说明
T返回实例的第一个元素。

错误码：

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

错误码ID错误信息
10200011The getFirst method cannot be bound.

示例：

let list: List<number> = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.getFirst();

getLast

getLast(): T

获取List实例中的最后一个元素。

系统能力： SystemCapability.Utils.Lang

返回值：

类型说明
T返回实例的最后一个元素。

错误码：

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

错误码ID错误信息
10200011The getLast method cannot be bound.

示例：

let list: List<number> = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);
let result = list.getLast();

[Symbol.iterator]

[Symbol.iterator](): IterableIterator<T>

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

说明：

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

系统能力： SystemCapability.Utils.Lang

返回值：

类型说明
IterableIterator<T>返回一个迭代器。

错误码：

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

错误码ID错误信息
10200011The Symbol.iterator method cannot be bound.

示例：

let list: List<number> = new List();
list.add(2);
list.add(4);
list.add(5);
list.add(4);

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

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

你可能感兴趣的鸿蒙文章

harmony 鸿蒙接口

harmony 鸿蒙系统公共事件定义(待停用)

harmony 鸿蒙系统公共事件定义

harmony 鸿蒙开发说明

harmony 鸿蒙企业设备管理概述（仅对系统应用开放）

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager模块)

harmony 鸿蒙@ohos.distributedBundle (分布式包管理)

harmony 鸿蒙@ohos.bundle (Bundle模块)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (企业设备管理扩展能力)

  • 所属分类： 后端技术
  • 本文标签： 软件 鸿蒙
  • 版权声明： 本文链接 https://seaxiang.com/blog/85a79f420b5949caba3351a20e78bb5b