线性容器ArrayList


线性容器ArrayList

icon-note.gif 说明: 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import ArrayList from '@ohos.util.ArrayList';
1

系统能力

SystemCapability.Utils.Lang

ArrayList

属性

名称 参数类型 可读 可写 说明
length number ArrayList的元素个数。

constructor

constructor()

ArrayList的构造函数。

示例:

let arrayList = new ArrayList();
1

add

add(element: T): boolean

在ArrayList尾部插入元素。

参数:

参数名 类型 必填 说明
element T 待插入的元素。

返回值:

类型 说明
boolean 插入成功返回true,失败返回false。

示例:

let arrayList = new ArrayList();
let result = arrayList.add("a");
let result1 = arrayList.add(1);
let b = [1, 2, 3];
let result2 = arrayList.add(b);
let c = {name: "lala", age: "13"};
let result3 = arrayList.add(false);
1
2
3
4
5
6
7

insert

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

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

参数:

参数名 类型 必填 说明
element T 被插入的元素。
index number 被插入的位置索引。

示例:

let arrayList = new ArrayList();
arrayList.insert("A", 0);
arrayList.insert(0, 1);
arrayList.insert(true, 2);
1
2
3
4

has

has(element: T): boolean

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

参数:

参数名 类型 必填 说明
element T 指定元素。

返回值:

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

示例:

let arrayList = new ArrayList();
let result = arrayList.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
arrayList.add("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
let result1 = arrayList.has("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
1
2
3
4

getIndexOf

getIndexOf(element: T): number

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

参数:

参数名 类型 必填 说明
element T 指定元素。

返回值:

类型 说明
number 返回指定元素第一次出现时的下标值,查找失败返回-1。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(2);
arrayList.add(1);
arrayList.add(2);
arrayList.add(4);
let result = arrayList.getIndexOf(2);
1
2
3
4
5
6
7
8
9

getLastIndexOf

getLastIndexOf(element: T): number

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

参数:

参数名 类型 必填 说明
element T 指定元素。

返回值:

类型 说明
number 返回指定元素最后一次出现时的下标值,查找失败返回-1。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(2);
arrayList.add(1);
arrayList.add(2);
arrayList.add(4);
let result = arrayList.getLastIndexOf(2);
1
2
3
4
5
6
7
8
9

removeByIndex

removeByIndex(index: number): T

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

参数:

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

返回值:

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

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(2);
arrayList.add(4);
let result = arrayList.removeByIndex(2);
1
2
3
4
5
6
7

remove

remove(element: T): boolean

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

参数:

参数名 类型 必填 说明
element T 指定元素。

返回值:

类型 说明
boolean 删除成功返回true,失败返回false。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
let result = arrayList.remove(2);
1
2
3
4
5
6

removeByRange

removeByRange(fromIndex: number, toIndex: number): void

从一段范围内删除元素,包括起始值但不包括终止值。

参数:

参数名 类型 必填 说明
fromIndex number 起始下标。
toIndex number 终止下标。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
arrayList.removeByRange(2, 4);
arrayList.removeByRange(4, 3);
arrayList.removeByRange(2, 6);
1
2
3
4
5
6
7
8

replaceAllElements

replaceAllElements(callbackfn: (value: T, index?: number, arrlist?: ArrayList<T>) => T, thisArg?: Object): void

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

参数:

参数名 类型 必填 说明
callbackfn function 回调函数。
thisArg Object callbackfn被调用时用作this值。

callbackfn的参数说明:

参数名 类型 必填 说明
value T 当前遍历到的元素。
index number 当前遍历到的下标值。
arrlist ArrayList<T> 当前调用replaceAllElements方法的实例对象。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
arrayList.replaceAllElements((value, index) => {
  return value = 2 * value;
});
arrayList.replaceAllElements((value, index) => {
  return value = value - 2;
});
1
2
3
4
5
6
7
8
9
10
11

forEach

forEach(callbackfn: (value: T, index?: number, arrlist?: ArrayList<T>) => void, thisArg?: Object): void

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

参数:

参数名 类型 必填 说明
callbackfn function 回调函数。
thisArg Object callbackfn被调用时用作this值。

callbackfn的参数说明:

参数名 类型 必填 说明
value T 当前遍历到的元素。
index number 当前遍历到的下标值。
arrlist ArrayList<T> 当前调用forEach方法的实例对象。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
arrayList.forEach((value, index) => {
  console.log("value:" + value, index);
});
1
2
3
4
5
6
7
8

sort

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

对ArrayList中的元素排序。

参数:

参数名 类型 必填 说明
comparator function 回调函数。

comparator的参数说明:

参数名 类型 必填 说明
firstValue T 前一项元素。
secondValue T 后一项元素。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
arrayList.sort((a, b) => a - b);
arrayList.sort((a, b) => b - a);
arrayList.sort();
1
2
3
4
5
6
7
8

subArrayList

subArrayList(fromIndex: number, toIndex: number): ArrayList<T>

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

参数:

参数名 类型 必填 说明
fromIndex number 起始下标。
toIndex number 终止下标。

返回值:

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

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
let result1 = arrayList.subArrayList(2, 4);
let result2 = arrayList.subArrayList(4, 3);
let result3 = arrayList.subArrayList(2, 6);
1
2
3
4
5
6
7
8

clear

clear(): void

清除ArrayList中的所有元素,并把length置为0。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
arrayList.clear();
1
2
3
4
5
6

clone

clone(): ArrayList<T>

克隆一个与ArrayList相同的实例,并返回克隆后的实例。修改克隆后的实例并不会影响原实例。

返回值:

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

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
let result = arrayList.clone();
1
2
3
4
5
6

getCapacity

getCapacity(): number

获取当前实例的容量大小。

返回值:

类型 说明
number 返回arraylist的容量大小。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
let result = arrayList.getCapacity();
1
2
3
4
5
6

convertToArray

convertToArray(): Array<T>

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

返回值:

类型 说明
Array<T> 返回数组类型。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
let result = arrayList.convertToArray();
1
2
3
4
5
6

isEmpty

isEmpty(): boolean

判断该ArrayList是否为空。

返回值:

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

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
let result = arrayList.isEmpty();
1
2
3
4
5
6

increaseCapacityTo

increaseCapacityTo(newCapacity: number): void

如果传入的新容量大于或等于ArrayList中的元素个数,将容量变更为新容量。

参数:

参数名 类型 必填 说明
newCapacity number 新容量。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
arrayList.increaseCapacityTo(2);
arrayList.increaseCapacityTo(8);
1
2
3
4
5
6
7

trimToCurrentLength

trimToCurrentLength(): void

把容量限制为当前的length大小。

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
arrayList.trimToCurrentLength();
1
2
3
4
5
6

[Symbol.iterator]

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

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

返回值:

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

示例:

let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);

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

// 使用方法二:
let iter = arrayList[Symbol.iterator]();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("value:" + temp);
  temp = iter.next().value;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18