harmony 鸿蒙@ohos.util.LinkedList (Linear Container LinkedList)
@ohos.util.LinkedList (Linear Container LinkedList)
LinkedList is implemented based on the doubly linked list. Each node of the doubly linked list has references pointing to the previous element and the next element. When querying an element, the system traverses the list from the beginning or end. LinkedList offers efficient insertion and removal operations but supports low query efficiency. LinkedList allows null elements.
Unlike List, which is a singly linked list, LinkedList is a doubly linked list that supports insertion and removal at both ends.
LinkedList is more efficient in data insertion than ArrayList, but less efficient in data access.
NOTE
Although using [index] in LinkedList can obtain an element with the given index, this operation will result in undefined results. Due to this reason, get() method is recommended.
Recommended use case: Use LinkedList for frequent insertion and removal operations when a doubly linked list is required.
This topic uses the following to identify the use of generics: - T: Type
NOTE
The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
Modules to Import
import { LinkedList } from '@kit.ArkTS';
LinkedList
Attributes
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Name | Type | Readable | Writable | Description |
---|---|---|---|---|
length | number | Yes | No | Number of elements in a linked list (called container later). |
constructor
constructor()
A constructor used to create a LinkedList instance.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200012 | The LinkedList’s constructor cannot be directly invoked. |
Example
let linkedList: LinkedList<string|number|boolean|object> = new LinkedList();
add
add(element: T): boolean
Adds an element at the end of this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
element | T | Yes | Target element. |
Return value
Type | Description |
---|---|
boolean | Returns true if the element is added successfully; returns false otherwise. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The add method cannot be bound. |
Example
let linkedList: LinkedList<string|number|boolean|object> = new LinkedList();
let result = linkedList.add("a");
let result1 = linkedList.add(1);
let b = [1, 2, 3];
let result2 = linkedList.add(b);
class C {
name: string = ''
age: string = ''
}
let c: C = {name : "Dylan", age : "13"};
let result3 = linkedList.add(c);
let result4 = linkedList.add(false);
addFirst
addFirst(element: T): void
Adds an element at the top of this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
element | T | Yes | Target element. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The addFirst method cannot be bound. |
Example
let linkedList: LinkedList<string|number|boolean|object> = new LinkedList();
linkedList.addFirst("a");
linkedList.addFirst(1);
let b = [1, 2, 3];
linkedList.addFirst(b);
class C {
name: string = ''
age: string = ''
}
let c: C = {name : "Dylan", age : "13"};
linkedList.addFirst(c);
linkedList.addFirst(false);
insert
insert(index: number, element: T): void
Inserts an element at the specified position in this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
index | number | Yes | Index of the position where the element is to be inserted. The value must be less than or equal to int32_max, that is, 2147483647. |
element | T | Yes | Target element. |
Error codes
For details about the error codes, see Universal Error Codes and Utils Error Codes.
ID | Error Message |
---|---|
401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
10200001 | The value of index is out of range. |
10200011 | The insert method cannot be bound. |
Example
let linkedList: LinkedList<string|number|boolean|object> = new LinkedList();
linkedList.insert(0, "A");
linkedList.insert(1, 0);
linkedList.insert(2, true);
has
has(element: T): boolean
Checks whether this container has the specified element.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
element | T | Yes | Target element. |
Return value
Type | Description |
---|---|
boolean | Returns true if the specified element is contained; returns false otherwise. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The has method cannot be bound. |
Example
let linkedList: LinkedList<string> = new LinkedList();
linkedList.add("squirrel");
let result = linkedList.has("squirrel");
get
get(index: number): T
Obtains an element at the specified position in this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
index | number | Yes | Position index of the target element. The value must be less than or equal to int32_max, that is, 2147483647. |
Return value
Type | Description |
---|---|
T | Element obtained. If the element does not exist, undefined is returned. |
Error codes
For details about the error codes, see Universal Error Codes and Utils Error Codes.
ID | Error Message |
---|---|
401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
10200011 | The get method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(2);
linkedList.add(1);
linkedList.add(2);
linkedList.add(4);
let result = linkedList.get(2);
getLastIndexOf
getLastIndexOf(element: T): number
Obtains the index of the last occurrence of the specified element in this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
element | T | Yes | Target element. |
Return value
Type | Description |
---|---|
number | Returns the position index if obtained; returns -1 otherwise. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The getLastIndexOf method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(2);
linkedList.add(1);
linkedList.add(2);
linkedList.add(4);
let result = linkedList.getLastIndexOf(2);
getIndexOf
getIndexOf(element: T): number
Obtains the index of the first occurrence of the specified element in this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
element | T | Yes | Target element. |
Return value
Type | Description |
---|---|
number | Returns the position index if obtained; returns -1 otherwise. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The getIndexOf method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(2);
linkedList.add(1);
linkedList.add(2);
linkedList.add(4);
let result = linkedList.getIndexOf(2);
removeByIndex
removeByIndex(index: number): T
Searches for an element based on its index and then removes it.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
index | number | Yes | Position index of the target element. The value must be less than or equal to int32_max, that is, 2147483647. |
Return value
Type | Description |
---|---|
T | Element removed. If the element does not exist, undefined is returned. |
Error codes
For details about the error codes, see Universal Error Codes and Utils Error Codes.
ID | Error Message |
---|---|
401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
10200001 | The value of index is out of range. |
10200011 | The removeByIndex method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(2);
linkedList.add(4);
let result = linkedList.removeByIndex(2);
removeFirst
removeFirst(): T
Removes the first element from this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Return value
Type | Description |
---|---|
T | Element removed. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200010 | Container is empty. |
10200011 | The removeFirst method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(2);
linkedList.add(4);
let result = linkedList.removeFirst();
removeLast
removeLast(): T
Removes the last element from this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Return value
Type | Description |
---|---|
T | Element removed. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200010 | Container is empty. |
10200011 | The removeLast method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(2);
linkedList.add(4);
let result = linkedList.removeLast();
remove
remove(element: T): boolean
Removes the first occurrence of the specified element from this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
element | T | Yes | Target element. |
Return value
Type | Description |
---|---|
boolean | Returns true if the element is removed successfully; returns false otherwise. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The remove method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(4);
let result = linkedList.remove(2);
removeFirstFound
removeFirstFound(element: T): boolean
Removes the first occurrence of the specified element from this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
element | T | Yes | Target element. |
Return value
Type | Description |
---|---|
boolean | Returns true if the element is removed; returns false if the element fails to be removed or does not exist. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200010 | Container is empty. |
10200011 | The removeFirstFound method cannot be bound. |
10200017 | The element does not exist in this container. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(4);
let result = linkedList.removeFirstFound(4);
removeLastFound
removeLastFound(element: T): boolean
Removes the last occurrence of the specified element from this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
element | T | Yes | Target element. |
Return value
Type | Description |
---|---|
boolean | Returns true if the element is removed; returns false if the element fails to be removed or does not exist. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200010 | Container is empty. |
10200011 | The removeLastFound method cannot be bound. |
10200017 | The element does not exist in this container. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(4);
let result = linkedList.removeLastFound(4);
clone
clone(): LinkedList<T>
Clones this container and returns a copy. The modification to the copy does not affect the original instance.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Return value
Type | Description |
---|---|
LinkedList<T> | New LinkedList instance obtained. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The clone method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(4);
let result = linkedList.clone();
forEach
forEach(callbackFn: (value: T, index?: number, LinkedList?: LinkedList<T>) => void, thisArg?: Object): void
Uses a callback to traverse the elements in this container and obtain their position indexes.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
callbackFn | function | Yes | Callback invoked to traverse the elements in the container. |
thisArg | Object | No | Value of this to use when callbackFn is invoked. The default value is this instance. |
callbackFn
Name | Type | Mandatory | Description |
---|---|---|---|
value | T | Yes | Value of the element that is currently traversed. |
index | number | No | Position index of the element that is currently traversed. The default value is 0. |
LinkedList | LinkedList<T> | No | Instance that calls the forEach API. The default value is this instance. |
Error codes
For details about the error codes, see Universal Error Codes and Utils Error Codes.
ID | Error Message |
---|---|
401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types. |
10200011 | The forEach method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(4);
linkedList.forEach((value: number, index?: number) => {
console.log("value:" + value, "index:" + index);
});
clear
clear(): void
Clears this container and sets its length to 0.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The clear method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(4);
linkedList.clear();
set
set(index: number, element: T): T
Replaces an element at the specified position in this container with a given element.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Parameters
Name | Type | Mandatory | Description |
---|---|---|---|
index | number | Yes | Position index of the target element. The value must be less than or equal to int32_max, that is, 2147483647. |
element | T | Yes | Element to be used for replacement. |
Return value
Type | Description |
---|---|
T | New element. If the operation fails, undefined is returned. |
Error codes
For details about the error codes, see Universal Error Codes and Utils Error Codes.
ID | Error Message |
---|---|
401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. |
10200001 | The value of index is out of range. |
10200011 | The set method cannot be bound. |
Example
let linkedList: LinkedList<number|string> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(4);
let result = linkedList.set(2, "b");
convertToArray
convertToArray(): Array<T>
Converts this container into an array.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Return value
Type | Description |
---|---|
Array<T> | Array obtained. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The convertToArray method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(4);
let result = linkedList.convertToArray();
getFirst
getFirst(): T
Obtains the first element in this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Return value
Type | Description |
---|---|
T | Returns the element if obtained; returns undefined otherwise. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The getFirst method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(4);
let result = linkedList.getFirst();
getLast
getLast(): T
Obtains the last element in this container.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Return value
Type | Description |
---|---|
T | Returns the element if obtained; returns undefined otherwise. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The getLast method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(4);
let result = linkedList.getLast();
[Symbol.iterator]
[Symbol.iterator](): IterableIterator<T>
Obtains an iterator, each item of which is a JavaScript object.
Atomic service API: This API can be used in atomic services since API version 12.
System capability: SystemCapability.Utils.Lang
Return value
Type | Description |
---|---|
IterableIterator<T> | Iterator obtained. |
Error codes
For details about the error codes, see Utils Error Codes.
ID | Error Message |
---|---|
10200011 | The Symbol.iterator method cannot be bound. |
Example
let linkedList: LinkedList<number> = new LinkedList();
linkedList.add(2);
linkedList.add(4);
linkedList.add(5);
linkedList.add(4);
// Method 1:
let items = Array.from(linkedList)
for (let item of items) {
console.log("value:" + item);
}
// Method 2:
let iter = linkedList[Symbol.iterator]();
let temp: IteratorResult<number> = iter.next();
while(!temp.done) {
console.log("value:" + temp.value);
temp = iter.next();
}
你可能感兴趣的鸿蒙文章
harmony 鸿蒙Compilation Toolchain Error Codes
harmony 鸿蒙TypeScript Compiler Error Codes
harmony 鸿蒙js-apis-arkts-collections
harmony 鸿蒙@arkts.math.Decimal (High-Precision Math Library Decimal)
harmony 鸿蒙@arkts.lang (ArkTS Base Capability)
harmony 鸿蒙@arkts.utils (ArkTS Utils)
- 所属分类: 后端技术
- 本文标签:
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦