非线性容器TreeSet
TreeSet基于TreeMap实现,在TreeSet中,只对value对象进行处理。TreeSet可用于存储一系列值的集合,元素中value唯一且有序。
TreeSet和HashSet相比,HashSet中的数据无序存放,而TreeSet是有序存放。它们集合中的元素都不允许重复,但HashSet允许放入null值,TreeSet不建议插入空值,可能会影响排序结果。
推荐使用场景: 一般需要存储有序集合的场景,可以使用TreeSet。
文档中存在泛型的使用,涉及以下泛型标记符:
- T: Type, 类
本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
constructor
constructor(comparator?: (firstValue: T, secondValue: T) => boolean)
TreeSet的构造函数。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
comparator | function | 否 | 用户自定义的比较函数。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200012 | The TreeSet's constructor cannot be directly invoked. |
示例:
- let treeSet = new TreeSet();
isEmpty
isEmpty(): boolean
判断该容器是否为空。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
boolean | 为空返回true,不为空返回false。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The isEmpty method cannot be bound. |
示例:
- const treeSet = new TreeSet();
- let result = treeSet.isEmpty();
has
has(value: T): boolean
判断此容器中是否含有该指定元素。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | T | 是 | 指定元素。 |
返回值:
类型 | 说明 |
---|---|
boolean | 包含指定元素返回true,否则返回false。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The has method cannot be bound. |
示例:
- let treeSet = new TreeSet();
- treeSet.has(123);
- treeSet.add(123);
- let result1 = treeSet.has(123);
getFirstValue
getFirstValue(): T
获取容器中排序第一的数据。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
T | 返回排序第一的数据。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The getFirstValue method cannot be bound. |
示例:
- let treeSet = new TreeSet();
- treeSet.add("squirrel");
- treeSet.add("sparrow");
- let result = treeSet.getFirstValue();
getLastValue
getLastValue(): T
获取容器中排序最后的数据。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
T | 返回排序最后的数据。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The getLastValue method cannot be bound. |
示例:
- let treeSet = new TreeSet();
- treeSet.add("squirrel");
- treeSet.add("sparrow");
- let result = treeSet.getLastValue();
add
add(value: T): boolean
向容器中添加一组数据。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | T | 是 | 添加的成员数据。 |
返回值:
类型 | 说明 |
---|---|
boolean | 成功添加新数据至容器返回true,否则返回false。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The add method cannot be bound. |
示例:
- let treeSet = new TreeSet();
- let result = treeSet.add("squirrel");
remove
remove(value: T): boolean
删除指定的元素。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | T | 是 | 指定的元素。 |
返回值:
类型 | 说明 |
---|---|
boolean | 成功删除元素返回true,否则返回false。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The remove method cannot be bound. |
示例:
- let treeSet = new TreeSet();
- treeSet.add("squirrel");
- treeSet.add("sparrow");
- let result = treeSet.remove("sparrow");
getLowerValue
getLowerValue(key: T): T
获取容器中比传入元素排序靠前一位的元素。
系统能力: SystemCapability.Utils.Lang
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
key | T | 是 | 对比的元素值。 |
返回值:
类型 | 说明 |
---|---|
T | 返回排序中对比元素前一位的数据。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The getLowerValue method cannot be bound. |
示例:
- 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
参数:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
key | T | 是 | 对比的元素。 |
返回值:
类型 | 说明 |
---|---|
T | 返回排序中传入元素后一位的数据。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The getHigherValue method cannot be bound. |
示例:
- let treeSet = new TreeSet();
- treeSet.add("squirrel");
- treeSet.add("sparrow");
- treeSet.add("gander");
- let result = treeSet.getHigherValue("sparrow");
popFirst
popFirst(): T
删除容器中排序最前的数据。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
T | 返回删除的数据。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The popFirst method cannot be bound. |
示例:
- let treeSet = new TreeSet();
- treeSet.add("squirrel");
- treeSet.add("sparrow");
- let result = treeSet.popFirst();
popLast
popLast(): T
删除容器中排序最后的数据。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
T | 返回删除的数据。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The popLast method cannot be bound. |
示例:
- let treeSet = new TreeSet();
- treeSet.add("squirrel");
- treeSet.add("sparrow");
- let result = treeSet.popLast();
clear
clear(): void
清除容器中的所有元素,并把length置为0。
系统能力: SystemCapability.Utils.Lang
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The clear method cannot be bound. |
示例:
- let treeSet = new TreeSet();
- treeSet.add("squirrel");
- treeSet.add("sparrow");
- treeSet.clear();
values
values(): IterableIterator<T>
返回包含此映射中键值的新迭代器对象。
系统能力: SystemCapability.Utils.Lang
返回值:
类型 | 说明 |
---|---|
IterableIterator<T> | 返回一个迭代器。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The values method cannot be bound. |
示例:
- 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 | function | 是 | 回调函数。 |
thisArg | Object | 否 | callbackFn被调用时用作this值。 |
callbackFn的参数说明:
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
value | T | 否 | 当前遍历到的value元素。 |
key | T | 否 | 当前遍历到的key元素。 |
set | TreeSet<T> | 否 | 当前调用forEach方法的实例对象。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The forEach method cannot be bound. |
示例:
- 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
返回值:
类型 | 说明 |
---|---|
IterableIterator<[T, T]> | 返回一个迭代器。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The entries method cannot be bound. |
示例:
- 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
返回值:
类型 | 说明 |
---|---|
IterableIterator<T> | 返回一个迭代器。 |
错误码:
以下错误码的详细介绍请参见语言基础类库错误码。
错误码ID | 错误信息 |
---|---|
10200011 | The Symbol.iterator method cannot be bound. |
示例:
- 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;
- }
更多建议: