js-apis-arraylist.md 19.2 KB
Newer Older
L
linhaoran 已提交
1 2 3 4 5
# 线性容器ArrayList

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

6 7 8 9 10 11 12 13
ArrayList是一种线性数据结构,底层基于数组实现。ArrayList会根据实际需要动态调整容量,每次扩容增加50%。

ArrayList和[Vector](js-apis-vector.md)相似,都是基于数组实现。它们都可以动态调整容量,但Vector每次扩容增加1倍。

ArrayList和[LinkedList](js-apis-linkedlist.md)相比,ArrayList的随机访问效率更高。但由于ArrayList的增删操作会影响数组内其他元素的移动,LinkedList的增加和删除操作效率更高。

**推荐使用场景:** 当需要频繁读取集合中的元素时,推荐使用ArrayList。

L
lengchangjing 已提交
14 15 16
文档中存在泛型的使用,涉及以下泛型标记符:<br>
- T: Type, 类

L
linhaoran 已提交
17 18
## 导入模块

19
```ts
20
import ArrayList from '@ohos.util.ArrayList';
L
linhaoran 已提交
21 22 23 24 25 26
```

## ArrayList

### 属性

Z
zengyawen 已提交
27 28
**系统能力:** SystemCapability.Utils.Lang

L
liu-ganlin 已提交
29
| 名称 | 类型 | 可读 | 可写 | 说明 |
L
linhaoran 已提交
30
| -------- | -------- | -------- | -------- | -------- |
Z
zengyawen 已提交
31
| length | number | 是 | 否 | ArrayList的元素个数。 |
L
linhaoran 已提交
32 33 34 35


### constructor

Z
zengyawen 已提交
36
constructor()
L
linhaoran 已提交
37 38 39

ArrayList的构造函数。

Z
zengyawen 已提交
40 41
**系统能力:** SystemCapability.Utils.Lang

L
liu-ganlin 已提交
42 43 44 45
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
46
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
47 48 49
| -------- | -------- |
| 10200012 | The ArrayList's constructor cannot be directly invoked. |

Z
zengyawen 已提交
50 51
**示例:**

52
```ts
Z
zengyawen 已提交
53 54
let arrayList = new ArrayList();
```
L
linhaoran 已提交
55 56 57 58


### add

Z
zengyawen 已提交
59
add(element: T): boolean
L
linhaoran 已提交
60 61 62

在ArrayList尾部插入元素。

Z
zengyawen 已提交
63 64
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
65 66 67 68 69 70 71 72 73 74 75 76
**参数:**

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

**返回值:**

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

L
liu-ganlin 已提交
77 78 79 80
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
81
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
82 83 84
| -------- | -------- |
| 10200011 | The add method cannot be bound. |

Z
zengyawen 已提交
85 86
**示例:**

87 88 89 90 91 92 93 94 95 96
```ts
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: "Dylon", age: "13"};
let result3 = arrayList.add(c);
let result4 = arrayList.add(false);
```
L
linhaoran 已提交
97 98 99

### insert

Z
zengyawen 已提交
100
insert(element: T, index: number): void
L
linhaoran 已提交
101 102 103

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

Z
zengyawen 已提交
104 105
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
106 107 108 109 110 111 112
**参数:**

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

L
liu-ganlin 已提交
113 114 115 116
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
117
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
118 119
| -------- | -------- |
| 10200011 | The insert method cannot be bound. |
L
liu-ganlin 已提交
120
| 10200001 | The parameter value is out of range. |
L
liu-ganlin 已提交
121

Z
zengyawen 已提交
122
**示例:**
L
linhaoran 已提交
123

124
```ts
Z
zengyawen 已提交
125 126 127 128 129
let arrayList = new ArrayList();
arrayList.insert("A", 0);
arrayList.insert(0, 1);
arrayList.insert(true, 2);
```
L
linhaoran 已提交
130 131 132

### has

Z
zengyawen 已提交
133
has(element: T): boolean
L
linhaoran 已提交
134 135 136

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

Z
zengyawen 已提交
137 138
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
139
**参数:**
L
linhaoran 已提交
140

Z
zengyawen 已提交
141 142 143
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| element | T | 是 | 指定元素。 |
L
linhaoran 已提交
144

Z
zengyawen 已提交
145 146 147 148 149 150
**返回值:**

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

L
liu-ganlin 已提交
151 152 153 154
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
155
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
156 157 158
| -------- | -------- |
| 10200011 | The has method cannot be bound. |

Z
zengyawen 已提交
159 160
**示例:**

161
```ts
Z
zengyawen 已提交
162
let arrayList = new ArrayList();
L
lengchangjing 已提交
163 164 165
let result = arrayList.has("squirrel");
arrayList.add("squirrel");
let result1 = arrayList.has("squirrel");
Z
zengyawen 已提交
166
```
L
linhaoran 已提交
167 168 169

### getIndexOf

Z
zengyawen 已提交
170
getIndexOf(element: T): number
L
linhaoran 已提交
171 172 173

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

Z
zengyawen 已提交
174 175
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
176 177 178 179 180 181 182 183 184 185 186 187
**参数:**

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

**返回值:**

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

L
liu-ganlin 已提交
188 189 190 191
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
192
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
193 194 195
| -------- | -------- |
| 10200011 | The getIndexOf method cannot be bound. |

Z
zengyawen 已提交
196 197
**示例:**

198
```ts
Z
zengyawen 已提交
199 200 201 202 203 204 205 206
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);
207
let result = arrayList.getIndexOf(2);
Z
zengyawen 已提交
208 209
```

L
linhaoran 已提交
210 211
### getLastIndexOf

Z
zengyawen 已提交
212
getLastIndexOf(element: T): number
L
linhaoran 已提交
213 214 215

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

Z
zengyawen 已提交
216 217
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
218 219 220 221 222 223 224 225 226 227 228 229
**参数:**

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

**返回值:**

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

L
liu-ganlin 已提交
230 231 232 233
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
234
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
235 236 237
| -------- | -------- |
| 10200011 | The getLastIndexOf method cannot be bound. |

Z
zengyawen 已提交
238 239
**示例:**

240
```ts
Z
zengyawen 已提交
241 242 243 244 245 246 247 248
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);
249
let result = arrayList.getLastIndexOf(2);
Z
zengyawen 已提交
250 251
```

L
linhaoran 已提交
252 253
### removeByIndex

Z
zengyawen 已提交
254
removeByIndex(index: number): T
L
linhaoran 已提交
255 256 257

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

Z
zengyawen 已提交
258 259
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
260 261 262 263 264 265 266 267 268 269 270 271
**参数:**

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

**返回值:**

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

L
liu-ganlin 已提交
272 273 274 275
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
276
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
277 278
| -------- | -------- |
| 10200011 | The removeByIndex method cannot be bound. |
L
liu-ganlin 已提交
279
| 10200001 | The parameter value is out of range. |
L
liu-ganlin 已提交
280

Z
zengyawen 已提交
281 282
**示例:**

283
```ts
Z
zengyawen 已提交
284 285 286 287 288 289
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(2);
arrayList.add(4);
290
let result = arrayList.removeByIndex(2);
Z
zengyawen 已提交
291
```
L
linhaoran 已提交
292 293 294

### remove

Z
zengyawen 已提交
295
remove(element: T): boolean
L
linhaoran 已提交
296 297 298

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

Z
zengyawen 已提交
299 300
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
301 302 303 304 305 306 307 308 309 310 311 312
**参数:**

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

**返回值:**

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

L
liu-ganlin 已提交
313 314 315 316
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
317
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
318 319 320
| -------- | -------- |
| 10200011 | The remove method cannot be bound. |

Z
zengyawen 已提交
321 322
**示例:**

323
```ts
Z
zengyawen 已提交
324 325 326 327 328
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
329
let result = arrayList.remove(2);
Z
zengyawen 已提交
330
```
L
linhaoran 已提交
331 332 333

### removeByRange

Z
zengyawen 已提交
334
removeByRange(fromIndex: number, toIndex: number): void
L
linhaoran 已提交
335 336 337

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

Z
zengyawen 已提交
338 339
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
340 341 342 343 344 345 346
**参数:**

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

L
liu-ganlin 已提交
347 348 349 350
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
351
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
352 353
| -------- | -------- |
| 10200011 | The removeByRange method cannot be bound. |
L
liu-ganlin 已提交
354
| 10200001 | The parameter value is out of range. |
L
liu-ganlin 已提交
355

Z
zengyawen 已提交
356 357
**示例:**

358
```ts
Z
zengyawen 已提交
359 360 361 362 363 364 365 366
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
arrayList.removeByRange(2, 4);
```

L
linhaoran 已提交
367
### replaceAllElements
368

369
replaceAllElements(callbackFn: (value: T, index?: number, arrlist?: ArrayList&lt;T&gt;) => T,
Z
zengyawen 已提交
370 371 372 373
thisArg?: Object): void

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

Z
zengyawen 已提交
374 375
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
376 377 378 379
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
380
| callbackFn | function | 是 | 回调函数。 |
Z
zengyawen 已提交
381 382 383 384 385 386
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |

callbackfn的参数说明:

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
387 388 389
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| arrlist | ArrayList&lt;T&gt; | 否 | 当前调用replaceAllElements方法的实例对象。 |
Z
zengyawen 已提交
390

L
liu-ganlin 已提交
391 392 393 394
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
395
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
396 397 398
| -------- | -------- |
| 10200011 | The replaceAllElements method cannot be bound. |

Z
zengyawen 已提交
399 400
**示例:**

401
```ts
Z
zengyawen 已提交
402 403 404 405 406
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
407
arrayList.replaceAllElements((value: number, index: number)=> {
Z
zengyawen 已提交
408 409
  return value = 2 * value;
});
410
arrayList.replaceAllElements((value: number, index: number) => {
Z
zengyawen 已提交
411 412 413 414
  return value = value - 2;
});
```

L
linhaoran 已提交
415
### forEach
416

417
forEach(callbackFn: (value: T, index?: number, arrlist?: ArrayList&lt;T&gt;) => void,
Z
zengyawen 已提交
418
thisArg?: Object): void
L
linhaoran 已提交
419 420 421

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

Z
zengyawen 已提交
422 423
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
424 425 426 427
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
428
| callbackFn | function | 是 | 回调函数。 |
Z
zengyawen 已提交
429 430 431 432 433 434 435 436
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |

callbackfn的参数说明:

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
437
| arrlist | ArrayList&lt;T&gt; | 否 | 当前调用forEach方法的实例对象。 |
Z
zengyawen 已提交
438

L
liu-ganlin 已提交
439 440 441 442
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
443
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
444 445 446
| -------- | -------- |
| 10200011 | The forEach method cannot be bound. |

Z
zengyawen 已提交
447 448
**示例:**

449
```ts
Z
zengyawen 已提交
450 451 452 453 454 455
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
arrayList.forEach((value, index) => {
L
lengchangjing 已提交
456
  console.log(`value:${value}`, index);
Z
zengyawen 已提交
457 458 459
});
```

L
linhaoran 已提交
460
### sort
461

Z
zengyawen 已提交
462 463 464 465
sort(comparator?: (firstValue: T, secondValue: T) => number): void

对ArrayList中的元素排序。

Z
zengyawen 已提交
466 467
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
468 469 470 471 472 473 474 475 476 477 478 479 480
**参数:**

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

comparator的参数说明:

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

L
liu-ganlin 已提交
481 482 483 484
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
485
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
486 487 488
| -------- | -------- |
| 10200011 | The sort method cannot be bound. |

Z
zengyawen 已提交
489 490
**示例:**

491
```ts
Z
zengyawen 已提交
492 493 494 495 496
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
497 498
arrayList.sort((a: number, b: number) => a - b);
arrayList.sort((a: number, b: number) => b - a);
Z
zengyawen 已提交
499 500 501
arrayList.sort();
```

L
linhaoran 已提交
502
### subArrayList
503

Z
zengyawen 已提交
504 505 506 507
subArrayList(fromIndex: number, toIndex: number): ArrayList&lt;T&gt;

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

Z
zengyawen 已提交
508 509
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
510 511 512 513 514 515 516 517 518 519 520 521 522
**参数:**

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

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| ArrayList&lt;T&gt; | 返回ArrayList对象实例。 |

L
liu-ganlin 已提交
523 524 525 526
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
527
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
528 529
| -------- | -------- |
| 10200011 | The subArrayList method cannot be bound. |
L
liu-ganlin 已提交
530
| 10200001 | The parameter value is out of range. |
L
liu-ganlin 已提交
531

Z
zengyawen 已提交
532 533
**示例:**

534
```ts
Z
zengyawen 已提交
535 536 537 538 539
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
540 541 542
let result1 = arrayList.subArrayList(2, 4);
let result2 = arrayList.subArrayList(4, 3);
let result3 = arrayList.subArrayList(2, 6);
Z
zengyawen 已提交
543
```
L
linhaoran 已提交
544 545

### clear
546

Z
zengyawen 已提交
547 548 549 550
clear(): void

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

Z
zengyawen 已提交
551 552
**系统能力:** SystemCapability.Utils.Lang

L
liu-ganlin 已提交
553 554 555 556
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
557
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
558 559 560
| -------- | -------- |
| 10200011 | The clear method cannot be bound. |

Z
zengyawen 已提交
561 562
**示例:**

563
```ts
Z
zengyawen 已提交
564 565 566 567 568 569 570 571
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
arrayList.clear();
```

L
linhaoran 已提交
572
### clone
573

Z
zengyawen 已提交
574 575
clone(): ArrayList&lt;T&gt; 

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

Z
zengyawen 已提交
578 579
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
580 581 582 583 584 585 586

**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| ArrayList&lt;T&gt; | 返回ArrayList对象实例。 |

L
liu-ganlin 已提交
587 588 589 590
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
591
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
592 593 594
| -------- | -------- |
| 10200011 | The clone method cannot be bound. |

Z
zengyawen 已提交
595 596
**示例:**

597
```ts
Z
zengyawen 已提交
598 599 600 601 602
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
603
let result = arrayList.clone();
Z
zengyawen 已提交
604 605
```

L
linhaoran 已提交
606
### getCapacity
607

Z
zengyawen 已提交
608
getCapacity(): number
L
linhaoran 已提交
609 610 611

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

Z
zengyawen 已提交
612 613
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
614 615 616 617 618 619
**返回值:**

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

L
liu-ganlin 已提交
620 621 622 623
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
624
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
625 626 627
| -------- | -------- |
| 10200011 | The getCapacity method cannot be bound. |

Z
zengyawen 已提交
628 629
**示例:**

630
```ts
Z
zengyawen 已提交
631 632 633 634 635
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
636
let result = arrayList.getCapacity();
Z
zengyawen 已提交
637 638
```

L
linhaoran 已提交
639
### convertToArray
640

Z
zengyawen 已提交
641 642 643 644
convertToArray(): Array&lt;T&gt;

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

Z
zengyawen 已提交
645 646
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
647 648 649 650 651 652
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| Array&lt;T&gt; | 返回数组类型。 |

L
liu-ganlin 已提交
653 654 655 656
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
657
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
658 659 660
| -------- | -------- |
| 10200011 | The convertToArray method cannot be bound. |

Z
zengyawen 已提交
661 662
**示例:**

663
```ts
Z
zengyawen 已提交
664 665 666 667 668
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
669
let result = arrayList.convertToArray();
Z
zengyawen 已提交
670 671
```

L
linhaoran 已提交
672
### isEmpty
673

Z
zengyawen 已提交
674
isEmpty(): boolean
L
linhaoran 已提交
675 676 677

判断该ArrayList是否为空。

Z
zengyawen 已提交
678 679
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
680 681 682 683 684 685
**返回值:**

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

L
liu-ganlin 已提交
686 687 688 689
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
690
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
691 692 693
| -------- | -------- |
| 10200011 | The isEmpty method cannot be bound. |

Z
zengyawen 已提交
694 695
**示例:**

696
```ts
Z
zengyawen 已提交
697 698 699 700 701
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
702
let result = arrayList.isEmpty();
Z
zengyawen 已提交
703 704
```

L
linhaoran 已提交
705
### increaseCapacityTo
706

Z
zengyawen 已提交
707
increaseCapacityTo(newCapacity: number): void
L
linhaoran 已提交
708 709 710

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

Z
zengyawen 已提交
711 712
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
713 714 715 716 717 718
**参数:**

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

L
liu-ganlin 已提交
719 720 721 722
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
723
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
724 725 726
| -------- | -------- |
| 10200011 | The increaseCapacityTo method cannot be bound. |

Z
zengyawen 已提交
727 728
**示例:**

729
```ts
Z
zengyawen 已提交
730 731 732 733 734 735 736 737 738
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
arrayList.increaseCapacityTo(2);
arrayList.increaseCapacityTo(8);
```

L
linhaoran 已提交
739
### trimToCurrentLength
740

Z
zengyawen 已提交
741
trimToCurrentLength(): void
L
linhaoran 已提交
742 743 744

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

Z
zengyawen 已提交
745 746
**系统能力:** SystemCapability.Utils.Lang

L
liu-ganlin 已提交
747 748 749 750
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
751
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
752 753 754
| -------- | -------- |
| 10200011 | The trimToCurrentLength method cannot be bound. |

Z
zengyawen 已提交
755 756
**示例:**

757
```ts
Z
zengyawen 已提交
758 759 760 761 762
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);
763
arrayList.trimToCurrentLength();
Z
zengyawen 已提交
764 765
```

L
linhaoran 已提交
766 767
### [Symbol.iterator]

Z
zengyawen 已提交
768 769 770 771
[Symbol.iterator]\(): IterableIterator&lt;T&gt;

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

Z
zengyawen 已提交
772 773
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
774 775 776 777 778 779
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| IterableIterator&lt;T&gt; | 返回一个迭代器。 |

L
liu-ganlin 已提交
780 781 782 783
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
784
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
785 786 787
| -------- | -------- |
| 10200011 | The Symbol.iterator method cannot be bound. |

Z
zengyawen 已提交
788 789
**示例:**

790
```ts
Z
zengyawen 已提交
791 792 793 794 795 796 797 798
let arrayList = new ArrayList();
arrayList.add(2);
arrayList.add(4);
arrayList.add(5);
arrayList.add(4);

// 使用方法一:
for (let item of arrayList) { 
L
lengchangjing 已提交
799
  console.log(`value:${item}`); 
Z
zengyawen 已提交
800 801 802 803 804 805
} 

// 使用方法二:
let iter = arrayList[Symbol.iterator]();
let temp = iter.next().value;
while(temp != undefined) {
L
lengchangjing 已提交
806
  console.log(`value:${temp}`);
Z
zengyawen 已提交
807 808 809
  temp = iter.next().value;
}
```