@ohos.util.TreeSet (非线性容器TreeSet)

TreeSet基于TreeMap实现,在TreeSet中,只对value对象进行处理。TreeSet可用于存储一系列值的集合,元素中value唯一且有序。

TreeSet和HashSet相比,HashSet中的数据无序存放,而TreeSet是有序存放。它们集合中的元素都不允许重复,但HashSet允许放入null值,TreeSet不建议插入空值,可能会影响排序结果。

推荐使用场景: 一般需要存储有序集合的场景,可以使用TreeSet。

文档中存在泛型的使用,涉及以下泛型标记符:

  • T:Type,类

说明:

本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import { TreeSet } from '@kit.ArkTS';

TreeSet

属性

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

名称 类型 可读 可写 说明
length number TreeSet的元素个数。

constructor

constructor(comparator?: (firstValue: T, secondValue: T) => boolean)

TreeSet的构造函数,支持通过比较函数对元素进行升序或降序排序。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.1。

参数:

参数名 类型 必填 说明
comparator function 用户自定义的比较函数,可通过比较关系对元素进行排序。默认值为hole(一个空白占位符),表示不提供比较函数。

错误码:

以下错误码的详细介绍请参见通用错误码语言基础类库错误码

错误码ID 错误信息
401 Parameter error. Possible causes: 1.Incorrect parameter types; 2.Parameter verification failed.
10200012 The TreeSet's constructor cannot be directly invoked.

示例:

//默认构造
let treeSet : TreeSet<string | number | boolean | Object> = new TreeSet<string | number | boolean | Object>();
//使用comparator firstValue < secondValue,表示期望结果为升序排序。反之firstValue > secondValue,表示为降序排序。
let treeSet : TreeSet<string> = new TreeSet<string>((firstValue: string, secondValue: string) : boolean => {return firstValue < secondValue});
treeSet.add("a");
treeSet.add("c");
treeSet.add("d");
treeSet.add("b");
let numbers = Array.from(treeSet.values())
for (let item of numbers) {
  console.info("TreeSet:" + item);
}
//当插入自定义类型时,则必须要提供比较函数。
class TestEntry{
  public id: number = 0;
}
let ts1: TreeSet<TestEntry> = new TreeSet<TestEntry>((t1: TestEntry, t2: TestEntry): boolean => {return t1.id > t2.id;});
let entry1: TestEntry = {
  id: 0
};
let entry2: TestEntry = {
  id: 1
}
ts1.add(entry1);
ts1.add(entry2);
console.info("treeSet: ", ts1.length);

constructor20+

constructor(comparator?: TreeSetComparator<T>)

TreeSet的构造函数,支持通过比较函数对元素进行升序或降序排序。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.2。

参数:

参数名 类型 必填 说明
comparator TreeSetComparator<T> 用户自定义的比较函数,可通过比较关系对元素进行排序。默认值为hole(一个空白占位符),表示不提供比较函数。

示例:

//默认构造
let treeSet : TreeSet<string | number | boolean | Object> = new TreeSet<string | number | boolean | Object>();
import { TreeSetComparator } from '@ohos.util.TreeSet';

//使用comparator firstValue < secondValue,表示期望结果为升序排序。反之firstValue > secondValue,表示为降序排序。
let treeSetCb: TreeSetComparator<string> = (firstValue: string, secondValue: string): number => {
  return secodValue.compareTo(firstValue);
};
let treeSet: TreeSet<string> = new TreeSet<string>(treeSetCb);
treeSet.add("a");
treeSet.add("c");
treeSet.add("d");
treeSet.add("b");
let numbers = Array.from(treeSet.values());
for (let item of numbers) {
  console.info("TreeSet: " + item);
}
//当插入自定义类型时,则必须要提供比较函数。
class TestEntry{
  public id: number = 0;
}
let treeSetCb: TreeSetComparator<TestEntry> = (firstValue: TestEntry, secondValue: TestEntry): number => {
  return secodValue.compareTo(firstValue);
};
let ts1: TreeSet<TestEntry> = new TreeSet<TestEntry>(treeSetCb);
let entry1: TestEntry = {
  id: 0
};
let entry2: TestEntry = {
  id: 1
}
ts1.add(entry1);
ts1.add(entry2);
console.info("treeSet: ", ts1.length);

isEmpty

isEmpty(): boolean

判断该容器是否为空。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

返回值:

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

错误码:

以下错误码的详细介绍请参见语言基础类库错误码

错误码ID 错误信息
10200011 The isEmpty method cannot be bound.

示例:

const treeSet : TreeSet<string | number | boolean | Object>  = new TreeSet<string | number | boolean | Object>();
let result = treeSet.isEmpty();

has

has(value: T): boolean

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

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
value T 指定元素。

返回值:

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

错误码:

以下错误码的详细介绍请参见语言基础类库错误码

错误码ID 错误信息
10200011 The has method cannot be bound.

示例:

let treeSet : TreeSet<number> = new TreeSet<number>();
treeSet.add(123);
let result = treeSet.has(123);

getFirstValue

getFirstValue(): T

获取容器中排序第一的数据,为空时返回undefined。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.1。

返回值:

类型 说明
T 返回排序第一的数据,为空时返回undefined。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码

错误码ID 错误信息
10200011 The getFirstValue method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.getFirstValue();

getFirstValue20+

getFirstValue(): T | undefined

获取容器中排序第一的数据,为空时返回undefined。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.2。

返回值:

类型 说明
T | undefined 返回排序第一的数据,为空时返回undefined。

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.getFirstValue();

getLastValue

getLastValue(): T

获取容器中排序最后的数据,为空时返回undefined。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.1。

返回值:

类型 说明
T 返回排序最后的数据,为空时返回undefined。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码

错误码ID 错误信息
10200011 The getLastValue method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.getLastValue();

getLastValue20+

getLastValue(): T | undefined

获取容器中排序最后的数据,为空时返回undefined。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.2。

返回值:

类型 说明
T | undefined 返回排序最后的数据,为空时返回undefined。

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.getLastValue();

add

add(value: T): boolean

向容器中添加一组数据。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
value T 添加的成员数据。

返回值:

类型 说明
boolean 成功添加新数据至容器返回true,否则返回false。

错误码:

以下错误码的详细介绍请参见通用错误码语言基础类库错误码

错误码ID 错误信息
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
10200011 The add method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
let result = treeSet.add("squirrel");

remove

remove(value: T): boolean

删除指定的元素。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

参数:

参数名 类型 必填 说明
value T 指定的元素。

返回值:

类型 说明
boolean 成功删除元素返回true,否则返回false。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码

错误码ID 错误信息
10200011 The remove method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.remove("sparrow");

getLowerValue

getLowerValue(key: T): T

获取容器中比传入元素排序靠前一位的元素,为空时返回undefined。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.1。

参数:

参数名 类型 必填 说明
key T 对比的元素值。

返回值:

类型 说明
T 获取容器中比传入元素排序靠前一位的元素,为空时返回undefined。

错误码:

以下错误码的详细介绍请参见通用错误码语言基础类库错误码

错误码ID 错误信息
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
10200011 The getLowerValue method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
treeSet.add("gander");
let result = treeSet.getLowerValue("sparrow");

getLowerValue20+

getLowerValue(key: T): T | undefined

获取容器中比传入元素排序靠前一位的元素,为空时返回undefined。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.2。

参数:

参数名 类型 必填 说明
key T 对比的元素值。

返回值:

类型 说明
T | undefined 获取容器中比传入元素排序靠前一位的元素,为空时返回undefined。

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
treeSet.add("gander");
let result = treeSet.getLowerValue("sparrow");

getHigherValue

getHigherValue(key: T): T

获取容器中比传入元素排序靠后一位的元素,为空时返回undefined。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.1。

参数:

参数名 类型 必填 说明
key T 对比的元素。

返回值:

类型 说明
T 返回排序中传入元素后一位的数据。为空时返回undefined。

错误码:

以下错误码的详细介绍请参见通用错误码语言基础类库错误码

错误码ID 错误信息
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
10200011 The getHigherValue method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
treeSet.add("gander");
let result = treeSet.getHigherValue("sparrow");

getHigherValue20+

getHigherValue(key: T): T | undefined

获取容器中比传入元素排序靠后一位的元素,为空时返回undefined。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.2。

参数:

参数名 类型 必填 说明
key T 对比的元素。

返回值:

类型 说明
T | undefined 返回排序中传入元素后一位的数据。为空时返回undefined。

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
treeSet.add("gander");
let result = treeSet.getHigherValue("sparrow");

popFirst

popFirst(): T

删除容器中排序最前面的数据,为空时返回undefined。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.1。

返回值:

类型 说明
T 返回删除的数据,为空时返回undefined。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码

错误码ID 错误信息
10200011 The popFirst method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.popFirst();

popFirst20+

popFirst(): T | undefined

删除容器中排序最前面的数据,为空时返回undefined。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.2。

返回值:

类型 说明
T | undefined 返回删除的数据,为空时返回undefined。

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.popFirst();

popLast

popLast(): T

删除容器中排序最后面的数据,为空时返回undefined。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.1。

返回值:

类型 说明
T 返回删除的数据,为空时返回undefined。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码

错误码ID 错误信息
10200011 The popLast method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.popLast();

popLast20+

popLast(): T | undefined

删除容器中排序最后面的数据,为空时返回undefined。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.2。

返回值:

类型 说明
T | undefined 返回删除的数据,为空时返回undefined。

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.popLast();

clear

clear(): void

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

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

错误码:

以下错误码的详细介绍请参见语言基础类库错误码

错误码ID 错误信息
10200011 The clear method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
treeSet.clear();

values

values(): IterableIterator<T>

返回包含此映射中键值的新迭代器对象。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

返回值:

类型 说明
IterableIterator<T> 返回一个迭代器。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码

错误码ID 错误信息
10200011 The values method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
let it = treeSet.values();
let t: IteratorResult<string> = it.next();
while(!t.done) {
  console.info("TreeSet: " + t.value);
  t = it.next()
}

forEach

forEach(callbackFn: (value?: T, key?: T, set?: TreeSet<T>) => void, thisArg?: Object): void

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

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.1。

参数:

参数名 类型 必填 说明
callbackFn function 回调函数。
thisArg Object callbackFn被调用时用作this值,默认值为当前实例对象。

callbackFn的参数说明:

参数名 类型 必填 说明
value T 当前遍历到的value元素,默认值为首个键值对的值。
key T 当前遍历到的key元素,默认值为首个键值对的键。
set TreeSet<T> 当前调用forEach方法的实例对象,默认值为当前实例对象。

错误码:

以下错误码的详细介绍请参见通用错误码语言基础类库错误码

错误码ID 错误信息
401 Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types.
10200011 The forEach method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet();
treeSet.add("sparrow");
treeSet.add("gull");
treeSet.forEach((value ?: string, key ?: string) :void => {
  console.log("value:" + value, "key:" + key);
});
// 不建议在forEach中使用set、remove方法,会导致死循环等不可预知的风险,可使用for循环来进行插入和删除。
let treeSet : TreeSet<string> = new TreeSet<string>();
for(let i = 0; i < 10; i++) {
  treeSet.add("sparrow" + i);
}
for(let i = 0; i < 10; i++) {
  treeSet.remove("sparrow" + i);
}

forEach20+

forEach(callbackfn: TreeSetForEachCb<T>): void

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

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.2。

参数:

参数名 类型 必填 说明
callbackFn TreeSetForEachCb<T> 回调函数。

示例:

import { TreeSetForEachCb } from '@ohos.util.TreeSet';

let treeSet: TreeSet<string> = new TreeSet<string>();
treeSet.add("sparrow");
treeSet.add("gull");
let treeSetCb: TreeSetForEachCb<string> = (value: string, key: string, set: TreeSet<string>) => {
  console.info("value: " + value, " key: "+ key);
};
treeSet.forEach(treeSetCb);

entries

entries(): IterableIterator<[T, T]>

返回包含此映射中键值对的新迭代器对象。

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

返回值:

类型 说明
IterableIterator<[T, T]> 返回一个迭代器。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码

错误码ID 错误信息
10200011 The entries method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
let it = treeSet.entries();
let t: IteratorResult<[string, string]> = it.next();
while(!t.done) {
  console.info("TreeSet: " + t.value);
  t = it.next()
}
// 不建议在entries中使用set、remove方法,会导致死循环等不可预知的风险,可使用for循环来进行插入和删除。
let treeSet : TreeSet<string> = new TreeSet<string>();
for(let i = 0; i < 10; i++) {
  treeSet.add("sparrow" + i);
}
for(let i = 0; i < 10; i++) {
  treeSet.remove("sparrow" + i);
}

[Symbol.iterator]

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

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

原子化服务API: 从API version 12开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.1。

返回值:

类型 说明
IterableIterator<T> 返回一个迭代器。

错误码:

以下错误码的详细介绍请参见语言基础类库错误码

错误码ID 错误信息
10200011 The Symbol.iterator method cannot be bound.

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
let numbers = Array.from(treeSet.values())
// 使用方法一:
for (let item of numbers) {
  console.log("value:" + item);
}
// 使用方法二:
let iter = treeSet[Symbol.iterator]();
let temp: IteratorResult<string> = iter.next().value;
while(temp != undefined) {
  console.log("value:" + temp);
  temp = iter.next().value;
}
// 不建议在Symbol.iterator中使用set、remove方法,会导致死循环等不可预知的风险,可使用for循环来进行插入和删除。
let treeSet : TreeSet<string> = new TreeSet<string>();
for(let i = 0; i < 10; i++) {
  treeSet.add("sparrow" + i);
}
for(let i = 0; i < 10; i++) {
  treeSet.remove("sparrow" + i);
}

$_iterator20+

$_iterator(): IterableIterator<T>

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

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.2。

返回值:

类型 说明
IterableIterator<T> 返回一个迭代器。

示例:

let treeSet : TreeSet<string> = new TreeSet<string>();
treeSet.add("squirrel");
treeSet.add("sparrow");
// 使用方法一:
for (let item of treeSet) {
  console.info("value:" + item);
}
// 使用方法二:
let iter = treeSet.$_iterator();
let temp: IteratorResult<string> = iter.next().value;
while(temp != undefined) {
  console.info("value:" + temp);
  temp = iter.next().value;
}

TreeSetForEachCb<T>20+

type TreeSetForEachCb<T> = (value: T, key: T, set: TreeSet<T>) => void

Tree中forEach方法的回调函数。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.2。

参数:

参数名 类型 必填 说明
value T 当前遍历到的value元素。
key T 当前遍历到的key元素。
set TreeSet<T> 当前调用forEach方法的实例对象。

TreeSetComparator<T>20+

type TreeSetComparator<T> = (firstValue: T, secondValue: T) => number

TreeSet中constructor方法的回调函数。

原子化服务API: 从API version 20开始,该接口支持在原子化服务中使用。

系统能力: SystemCapability.Utils.Lang

ArkTS版本: 该接口仅适用于ArkTS1.2。

参数:

参数名 类型 必填 说明
firstValue T 比较关系中第一个元素。
secondValue T 比较关系中第二个元素。