线性容器Queue
本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
Queue的特点是先进先出，在尾部增加元素，在头部删除元素。根据循环队列的数据结构实现。
Queue和Deque相比，Queue只能在一端删除一端增加，Deque可以两端增删。
推荐使用场景： 一般符合先进先出的场景可以使用Queue。
文档中存在泛型的使用,涉及以下泛型标记符:
- T: Type, 类
constructor
constructor()
Queue的构造函数。
系统能力： SystemCapability.Utils.Lang
错误码：
以下错误码的详细介绍请参见语言基础类库错误码。
| 错误码ID | 错误信息 |
|---|---|
| 10200012 | The Queue's constructor cannot be directly invoked. |
示例：
- let queue = new Queue();
add
add(element: T): boolean
在队列尾部插入元素。
系统能力： SystemCapability.Utils.Lang
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| element | T | 是 | 添加进去的元素。 |
返回值：
| 类型 | 说明 |
|---|---|
| boolean | 插入成功返回true，否则返回false。 |
错误码：
以下错误码的详细介绍请参见语言基础类库错误码。
| 错误码ID | 错误信息 |
|---|---|
| 10200011 | The add method cannot be bound. |
示例：
- let queue = new Queue();
- let result = queue.add("a");
- let result1 = queue.add(1);
- let b = [1, 2, 3];
- let result2 = queue.add(b);
- let c = {name : "Dylon", age : "13"};
- let result3 = queue.add(c);
pop
pop(): T
删除头元素并返回该删除元素。
系统能力： SystemCapability.Utils.Lang
返回值：
| 类型 | 说明 |
|---|---|
| T | 返回删除的元素。 |
错误码：
以下错误码的详细介绍请参见语言基础类库错误码。
| 错误码ID | 错误信息 |
|---|---|
| 10200011 | The pop method cannot be bound. |
示例：
- let queue = new Queue();
- queue.add(2);
- queue.add(4);
- queue.add(5);
- queue.add(2);
- queue.add(4);
- let result = queue.pop();
getFirst
getFirst(): T
获取队列的头元素。
系统能力： SystemCapability.Utils.Lang
返回值：
| 类型 | 说明 |
|---|---|
| T | 返回获取的元素。 |
错误码：
以下错误码的详细介绍请参见语言基础类库错误码。
| 错误码ID | 错误信息 |
|---|---|
| 10200011 | The getFirst method cannot be bound. |
示例：
- let queue = new Queue();
- queue.add(2);
- queue.add(4);
- queue.add(5);
- queue.add(2);
- let result = queue.getFirst();
forEach
forEach(callbackFn: (value: T, index?: number, Queue?: Queue<T>) => void,
thisArg?: Object): void
通过回调函数来遍历Queue实例对象上的元素以及元素对应的下标。
系统能力： SystemCapability.Utils.Lang
参数：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| callbackFn | function | 是 | 回调函数。 |
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |
callbackfn的参数说明：
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| value | T | 是 | 当前遍历到的元素。 |
| index | number | 否 | 当前遍历到的下标值。 |
| Queue | Queue<T> | 否 | 当前调用forEach方法的实例对象。 |
错误码：
以下错误码的详细介绍请参见语言基础类库错误码。
| 错误码ID | 错误信息 |
|---|---|
| 10200011 | The forEach method cannot be bound. |
示例：
- let queue = new Queue();
- queue.add(2);
- queue.add(4);
- queue.add(5);
- queue.add(4);
- queue.forEach((value, index) => {
- console.log("value:" + value, "index:" + index);
- });
[Symbol.iterator]
[Symbol.iterator](): IterableIterator<T>
返回一个迭代器，迭代器的每一项都是一个 JavaScript 对象,并返回该对象。
系统能力： SystemCapability.Utils.Lang
返回值：
| 类型 | 说明 |
|---|---|
| IterableIterator<T> | 返回一个迭代器。 |
错误码：
以下错误码的详细介绍请参见语言基础类库错误码。
| 错误码ID | 错误信息 |
|---|---|
| 10200011 | The Symbol.iterator method cannot be bound. |
示例：
- let queue = new Queue();
- queue.add(2);
- queue.add(4);
- queue.add(5);
- queue.add(4);
- // 使用方法一：
- for (let item of queue) {
- console.log("value:" + item);
- }
- // 使用方法二：
- let iter = queue[Symbol.iterator]();
- let temp = iter.next().value;
- while(temp != undefined) {
- console.log("value:" + temp);
- temp = iter.next().value;
- }