# 线性容器List

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


## 导入模块

```
import List from '@ohos.list'  
```


## 权限

无


## List


### 属性

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| length | number | 是 | 否 | 获取List 的元素个数 |


### constructor

constructor(_head?: NodeObj<T>) 

constructor是List的构造函数。

- 参数：
  | 参数名 | 类型 | 可读 | 可写 | 说明 |
  | -------- | -------- | -------- | -------- | -------- |
  | _head | NodeObj<T> | 是 | 否 | 入参对象,节点对象,含有element,和next指向 |

- 示例：
  ```
  let list = new List();
  ```


### add

add(element: T): boolean

在List尾部插入元素

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 添加进去的元素 |

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

- 示例:
  ```
  const list = new List;
  list.add("a");
  list.add(1);
  let b = [1,2,3];
  list.add(b);
  let c = {name:"lala",age:"13"};
  list.add(false)
  ```

### insert

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

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

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 被插入的元素 |
  | index | number | 是 | 被插入的元素 |

- 示例:
  ```
  let list = new List()
  list.insert("A",0);
  list.insert(0,1);
  list.insert(true,2);

  ```

### has

has(element: T): boolean

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

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 是否包含的元素 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 是否包含指定元素 |

- 示例:
  ```
  const list = new List()
  list.has("Ahfbrgrbgnutfodgorrogorg");
  list.add("Ahfbrgrbgnutfodgorrogorg");
  list.has("Ahfbrgrbgnutfodgorrogorg");

  ```

### get

get(index: number): T  

根据下标获取List中的元素

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | index | number | 是 | 要查找的下标 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 根据下标查找到的元素 |

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(2);
  list.add(1);
  list.add(2);
  list.add(4);
  list.get(2);

  ```
### getLastIndexOf

getLastIndexOf(element: T): number

查找指定元素最后一次出现的下标值,如果没有找到该元素返回-1

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 被查找的元素 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回最后一次找到指定元素的下标,没有找到返回-1 |

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(2);
  list.add(1);
  list.add(2);
  list.add(4);
  list.getLastIndexOf(2);

  ```

### getIndexOf

getIndexOf(element: T): number

查找指定元素第一次出现的下标值,如果没有找到该元素返回-1

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 被查找的元素 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 返回第一次找到指定元素的下标,没有找到返回-1 |

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(2);
  list.add(1);
  list.add(2);
  list.add(4);
  list.getIndexOf(2);

  ```

### equal

equal(obj: Object): boolean

比较指定对象与此List是否相等。如果对象与此列表相同，返回true,否则返回false

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | obj | Object | 是 | 用来比较的对象 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 返回boolean类型 |

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(2);
  const obj1 = new List();
  obj1.add(2);
  obj1.add(4);
  obj1.add(5);
  list.equal(obj1);
  const obj2 = {name: "lala", age: "13"};
  list.equal(obj2);
  ```
### removeByIndex

removeByIndex(index: number): T

根据下标删除元素并返回该删除元素

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | index | number | 是 | 删除元素的下标 |

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

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(2);
  list.add(4);
  list.removeByIndex(2);

  ```

### remove

remove(element: T): boolean

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

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 指定删除的元素 |

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

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(4);
  list.remove(2);

  ```

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

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

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

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

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(4);
  list.replaceAllElements((value,index)=>{
    return value = 2*value;
  });
  list.replaceAllElements((value,index)=>{
    return value = value - 2;
  });

  ```
### forEach
forEach(callbackfn: (value: T, index?: number, list?: List<T>) => void,
thisArg?: Object): void 

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

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

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


- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(4);
  list.forEach((value,index)=>{
    console.log(value,index)
  });

  ```
### sort
sort(comparator: (firstValue: T, secondValue: T) => number): void
 
对List中的元素进行一个排序操作

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

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

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(4);
  list.sort(a,b=>a-b);
  list.sort(a,b=>b-a);

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

根据下标截取List中的一段元素,并返回这一段list实例,包前不包后
- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | fromIndex | number | 是 | 起始下标 |
  | toIndex | number | 是 | 终止下标 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | List<T> | 返回List对象实例 |

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(4);
  list.subList(2,4);
  list.subList(4,3);
  list.subList(2,6);
 
  ```

### clear
clear(): void

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

- 示例:
  ```
  const 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 中指定位置的元素替换为指定元素

- 参数：
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | index | number | 是 | 查找的下标 |
  | element | T | 是 | 用来替换的元素 |

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回T类型 |

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(4);
  list.set(2,"b");
 
  ```
### convertToArray
convertToArray(): Array<T>

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

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | Array<T> | 返回数组类型 |

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(4);
  list.convertToArray();

  ```
### isEmpty
isEmpty(): boolean 

判断该List是否为空

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

- 示例:
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(4);
  list.isEmpty();

  ```
### getFirst

getFirst(): T
获取List实例中的第一个元素

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回T型 |


- 示例：
  ```
  const list = new Vector();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(4);
  list.getFirst();
  ```
### getLast

getLast(): T 
获取List实例中的最后一个元素

- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回T型 |


- 示例：
  ```
  const list = new Vector();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(4);
  list.getLast();
  ```

### [Symbol.iterator]

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


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


- 返回值：
  | 类型 | 说明 |
  | -------- | -------- |
  | IterableIterator&lt;[T,&nbsp;boolean]&gt; | 返回一个迭代器。 |


- 示例：
  ```
  const list = new List();
  list.add(2);
  list.add(4);
  list.add(5);
  list.add(4);
  for (let item of list) { 
    console.log(item); 
  } 
  ```