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

版本：v3.1 Beta

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

更新时间: 2023-02-24 16:50

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

TreeSet和​​HashSet​​相比，HashSet中的数据无序存放，而TreeSet是有序存放。它们集合中的元素都不允许重复，但HashSet允许放入null值，TreeSet不允许。

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

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

• T： Type，类

说明

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

导入模块

import TreeSet from '@ohos.util.TreeSet';

TreeSet

属性

系统能力： SystemCapability.Utils.Lang

constructor

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

TreeSet的构造函数。

系统能力： SystemCapability.Utils.Lang

参数：

错误码：

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

示例：

let treeSet = new TreeSet();

isEmpty

isEmpty(): boolean

判断该容器是否为空。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

const treeSet = new TreeSet();
let result = treeSet.isEmpty();

has

has(value: T): boolean

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

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

let treeSet = new TreeSet();
treeSet.has(123);
treeSet.add(123);
let result1 = treeSet.has(123);

getFirstValue

getFirstValue(): T

获取容器中排序第一的数据。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

let treeSet = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.getFirstValue();

getLastValue

getLastValue(): T

获取容器中排序最后的数据。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

let treeSet = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.getLastValue();

add

add(value: T): boolean

向容器中添加一组数据。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

let treeSet = new TreeSet();
let result = treeSet.add("squirrel");

remove

remove(value: T): boolean

删除指定的元素。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

let treeSet = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.remove("sparrow");

getLowerValue

getLowerValue(key: T): T

获取容器中比传入元素排序靠前一位的元素。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

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

getHigherValue

getHigherValue(key: T): T

获取容器中比传入元素排序靠后一位的元素。

系统能力： SystemCapability.Utils.Lang

参数：

返回值：

错误码：

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

示例：

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

popFirst

popFirst(): T

删除容器中排序最前的数据。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

let treeSet = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.popFirst();

popLast

popLast(): T

删除容器中排序最后的数据。

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

let treeSet = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
let result = treeSet.popLast();

clear

clear(): void

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

系统能力： SystemCapability.Utils.Lang

错误码：

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

示例：

let treeSet = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
treeSet.clear();

values

values(): IterableIterator<T>

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

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

let treeSet = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
let iter = treeSet.values();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("value:" + temp);
  temp = iter.next().value;
}

forEach

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

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

系统能力： SystemCapability.Utils.Lang

参数：

callbackFn的参数说明：

错误码：

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

示例：

let treeSet = new TreeSet();
treeSet.add("sparrow");
treeSet.add("gull");
treeSet.forEach((value, key) => {
  console.log("value:" + value, "key:" + key);
});

entries

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

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

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

let treeSet = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
let iter = treeSet.entries();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("key:" + temp[0]);
  console.log("value:" + temp[1]);
  temp = iter.next().value;
}

[Symbol.iterator]

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

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

系统能力： SystemCapability.Utils.Lang

返回值：

错误码：

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

示例：

let treeSet = new TreeSet();
treeSet.add("squirrel");
treeSet.add("sparrow");
  
// 使用方法一：
for (let item of treeSet) { 
  console.log("value:" + item);
}

// 使用方法二：
let iter = treeSet[Symbol.iterator]();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("value:" + temp);
  temp = iter.next().value;
}

文章转载自：​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-treeset-0000001478061981-V3?catalogVersion=V3#ZH-CN_TOPIC_0000001478061981__导入模块​​