openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2024-10-07 14:13:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
6e1c15a141
interface_sdk-js/api/@ohos.util.List.d.ts
wang-jingwu001 5fe91741f5 Ease of use issue, 401 error message rectification 
Signed-off-by: wang-jingwu001 <wangjingwu4@huawei.com>
https://gitee.com/openharmony/interface_sdk-js/issues/I9J4Q6
2024-04-28 14:07:35 +08:00

560 lines
23 KiB
TypeScript
Raw Blame History

/*
* Copyright (c) 2021-2022 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ArkTS
*/
/**
* List is implemented based on the singly linked list. Each node has a reference pointing to the next element.
* When querying an element, the system traverses the list from the beginning.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* List is implemented based on the singly linked list. Each node has a reference pointing to the next element.
* When querying an element, the system traverses the list from the beginning.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
declare class List<T> {
/**
* A constructor used to create a List object.
*
* @throws { BusinessError } 10200012 - The List's constructor cannot be directly invoked.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* A constructor used to create a List object.
*
* @throws { BusinessError } 10200012 - The List's constructor cannot be directly invoked.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
constructor();
/**
* Gets the element number of the List. This is a number one higher than the highest index in the list.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets the element number of the List. This is a number one higher than the highest index in the list.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
length: number;
/**
* Appends the specified element to the end of this list.
*
* @param { T } element - element element to be appended to this list
* @returns { boolean } the boolean type, returns true if the addition is successful, and returns false if it fails.
* @throws { BusinessError } 10200011 - The add method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Appends the specified element to the end of this list.
*
* @param { T } element - element element to be appended to this list
* @returns { boolean } the boolean type, returns true if the addition is successful, and returns false if it fails.
* @throws { BusinessError } 10200011 - The add method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
add(element: T): boolean;
/**
* Inserts the specified element at the specified position in this list.
*
* @param { T } element - element element element to be inserted
* @param { number } index - index index index at which the specified element is to be inserted
* @throws { BusinessError } 10200011 - The insert method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Inserts the specified element at the specified position in this list.
*
* @param { T } element - element element element to be inserted
* @param { number } index - index index index at which the specified element is to be inserted
* @throws { BusinessError } 10200011 - The insert method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* 3.Parameter verification failed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
insert(element: T, index: number): void;
/**
* Returns the element at the specified position in this list,
* or returns undefined if this list is empty
*
* @param { number } index - index index specified position
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The get method cannot be bound.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Returns the element at the specified position in this list,
* or returns undefined if this list is empty
*
* @param { number } index - index index specified position
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The get method cannot be bound.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
get(index: number): T;
/**
* Check if list contains the specified element
*
* @param { T } element - element element element to be contained
* @returns { boolean } the boolean type,if list contains the specified element,return true,else return false
* @throws { BusinessError } 10200011 - The has method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check if list contains the specified element
*
* @param { T } element - element element element to be contained
* @returns { boolean } the boolean type,if list contains the specified element,return true,else return false
* @throws { BusinessError } 10200011 - The has method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
has(element: T): boolean;
/**
* Returns the index of the first occurrence of the specified element
* in this list, or -1 if this list does not contain the element.
*
* @param { T } element - element element element to be contained
* @returns { number } the number type ,returns the lowest index such that or -1 if there is no such index.
* @throws { BusinessError } 10200011 - The getIndexOf method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Returns the index of the first occurrence of the specified element
* in this list, or -1 if this list does not contain the element.
*
* @param { T } element - element element element to be contained
* @returns { number } the number type ,returns the lowest index such that or -1 if there is no such index.
* @throws { BusinessError } 10200011 - The getIndexOf method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
getIndexOf(element: T): number;
/**
* Find the corresponding element according to the index.
*
* @param { number } index - index index the index in the list
* @returns { T } the T type ,returns undefined if list is empty,If the index is
* out of bounds (greater than or equal to length or less than 0), throw an exception
* @throws { BusinessError } 10200011 - The removeByIndex method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Find the corresponding element according to the index.
*
* @param { number } index - index index the index in the list
* @returns { T } the T type ,returns undefined if list is empty,If the index is
* out of bounds (greater than or equal to length or less than 0), throw an exception
* @throws { BusinessError } 10200011 - The removeByIndex method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
removeByIndex(index: number): T;
/**
* Removes the first occurrence of the specified element from this list,
* if it is present. If the list does not contain the element, it is
* unchanged. More formally, removes the element with the lowest index
*
* @param { T } element - element element element to remove
* @returns { boolean } the boolean type ,If there is no such element, return false
* @throws { BusinessError } 10200011 - The remove method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Removes the first occurrence of the specified element from this list,
* if it is present. If the list does not contain the element, it is
* unchanged. More formally, removes the element with the lowest index
*
* @param { T } element - element element element to remove
* @returns { boolean } the boolean type ,If there is no such element, return false
* @throws { BusinessError } 10200011 - The remove method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
remove(element: T): boolean;
/**
* Returns in the index of the last occurrence of the specified element in this list ,
* or -1 if the list does not contain the element.
*
* @param { T } element - element element element to find
* @returns { number } the number type
* @throws { BusinessError } 10200011 - The getLastIndexOf method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Returns in the index of the last occurrence of the specified element in this list ,
* or -1 if the list does not contain the element.
*
* @param { T } element - element element element to find
* @returns { number } the number type
* @throws { BusinessError } 10200011 - The getLastIndexOf method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
getLastIndexOf(element: T): number;
/**
* Returns the first element (the item at index 0) of this list.
* or returns undefined if list is empty
*
* @returns { T } the T type ,returns undefined if list is empty
* @throws { BusinessError } 10200011 - The getFirst method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Returns the first element (the item at index 0) of this list.
* or returns undefined if list is empty
*
* @returns { T } the T type ,returns undefined if list is empty
* @throws { BusinessError } 10200011 - The getFirst method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
getFirst(): T;
/**
* Returns the Last element (the item at index length-1) of this list.
* or returns undefined if list is empty
*
* @returns { T } the T type ,returns undefined if list is empty
* @throws { BusinessError } 10200011 - The getLast method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Returns the Last element (the item at index length-1) of this list.
* or returns undefined if list is empty
*
* @returns { T } the T type ,returns undefined if list is empty
* @throws { BusinessError } 10200011 - The getLast method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
getLast(): T;
/**
* Replaces the element at the specified position in this List with the specified element
*
* @param { number } index - index index index to find
* @param { T } element - element element replaced element
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The set method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Replaces the element at the specified position in this List with the specified element
*
* @param { number } index - index index index to find
* @param { T } element - element element replaced element
* @returns { T } the T type
* @throws { BusinessError } 10200011 - The set method cannot be bound.
* @throws { BusinessError } 10200001 - The value of index is out of range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
set(index: number, element: T): T;
/**
* Compares the specified object with this list for equality.if the object are the same as this list
* return true, otherwise return false.
*
* @param { Object } obj - obj obj Compare objects
* @returns { boolean } the boolean type
* @throws { BusinessError } 10200011 - The equal method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Compares the specified object with this list for equality.if the object are the same as this list
* return true, otherwise return false.
*
* @param { Object } obj - obj obj Compare objects
* @returns { boolean } the boolean type
* @throws { BusinessError } 10200011 - The equal method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
equal(obj: Object): boolean;
/**
* Replaces each element of this list with the result of applying the operator to that element.
*
* @param { function } callbackFn - callbackFn
* callbackFn (required) A function that accepts up to three arguments.
* The function to be called for each element.
* @param { Object } [thisArg] - thisArg
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Replaces each element of this list with the result of applying the operator to that element.
*
* @param { function } callbackFn - callbackFn
* callbackFn (required) A function that accepts up to three arguments.
* The function to be called for each element.
* @param { Object } [thisArg] - thisArg
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The forEach method cannot be bound.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
forEach(callbackFn: (value: T, index?: number, List?: List<T>) => void, thisArg?: Object): void;
/**
* Sorts this list according to the order induced by the specified comparator
*
* @param { function } comparator - comparator
* comparator (required) A function that accepts up to two arguments.
* Specifies the sort order. Must be a function,return number type,If it returns firstValue
* minus secondValue, it returns an list sorted in ascending order;If it returns secondValue
* minus firstValue, it returns an list sorted in descending order;
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200011 - The sort method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Sorts this list according to the order induced by the specified comparator
*
* @param { function } comparator - comparator
* comparator (required) A function that accepts up to two arguments.
* Specifies the sort order. Must be a function,return number type,If it returns firstValue
* minus secondValue, it returns an list sorted in ascending order;If it returns secondValue
* minus firstValue, it returns an list sorted in descending order;
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @throws { BusinessError } 10200011 - The sort method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
sort(comparator: (firstValue: T, secondValue: T) => number): void;
/**
* Removes all of the elements from this list.The list will
* be empty after this call returns.length becomes 0
*
* @throws { BusinessError } 10200011 - The clear method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Removes all of the elements from this list.The list will
* be empty after this call returns.length becomes 0
*
* @throws { BusinessError } 10200011 - The clear method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
clear(): void;
/**
* Returns a view of the portion of this list between the specified fromIndex,inclusive,and toIndex,exclusive
*
* @param { number } fromIndex - fromIndex fromIndex The starting position of the index, containing the value at that index position
* @param { number } toIndex - toIndex toIndex the end of the index, excluding the value at that index
* @returns { List<T> }
* @throws { BusinessError } 10200011 - The getSubList method cannot be bound.
* @throws { BusinessError } 10200001 - The value of fromIndex or toIndex is out of range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Returns a view of the portion of this list between the specified fromIndex,inclusive,and toIndex,exclusive
*
* @param { number } fromIndex - fromIndex fromIndex The starting position of the index, containing the value at that index position
* @param { number } toIndex - toIndex toIndex the end of the index, excluding the value at that index
* @returns { List<T> }
* @throws { BusinessError } 10200011 - The getSubList method cannot be bound.
* @throws { BusinessError } 10200001 - The value of fromIndex or toIndex is out of range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
getSubList(fromIndex: number, toIndex: number): List<T>;
/**
* Replaces each element of this list with the result of applying the operator to that element.
*
* @param { function } callbackFn - callbackFn
* callbackFn (required) A function that accepts up to three arguments.
* The function to be called for each element.
* @param { Object } [thisArg] - thisArg
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The replaceAllElements method cannot be bound.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Replaces each element of this list with the result of applying the operator to that element.
*
* @param { function } callbackFn - callbackFn
* callbackFn (required) A function that accepts up to three arguments.
* The function to be called for each element.
* @param { Object } [thisArg] - thisArg
* thisArg (Optional) The value to be used as this value for when callbackFn is called.
* If thisArg is omitted, undefined is used as the this value.
* @throws { BusinessError } 10200011 - The replaceAllElements method cannot be bound.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
replaceAllElements(callbackFn: (value: T, index?: number, list?: List<T>) => T, thisArg?: Object): void;
/**
* convert list to array
*
* @returns { Array<T> } the Array type
* @throws { BusinessError } 10200011 - The convertToArray method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* convert list to array
*
* @returns { Array<T> } the Array type
* @throws { BusinessError } 10200011 - The convertToArray method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
convertToArray(): Array<T>;
/**
* Determine whether list is empty and whether there is an element
*
* @returns { boolean } the boolean type
* @throws { BusinessError } 10200011 - The isEmpty method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Determine whether list is empty and whether there is an element
*
* @returns { boolean } the boolean type
* @throws { BusinessError } 10200011 - The isEmpty method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
isEmpty(): boolean;
/**
* returns an iterator.Each item of the iterator is a Javascript Object
*
* @returns { IterableIterator<T> }
* @throws { BusinessError } 10200011 - The Symbol.iterator method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* returns an iterator.Each item of the iterator is a Javascript Object
*
* @returns { IterableIterator<T> }
* @throws { BusinessError } 10200011 - The Symbol.iterator method cannot be bound.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
[Symbol.iterator](): IterableIterator<T>;
}
export default List;
Reference in New Issue View Git Blame Copy Permalink