TreeSet基于[TreeMap]實現，在TreeSet中，只對value對象進行處理。TreeSet可用于存儲一系列值的集合，元素中value唯一且有序。

TreeSet和[HashSet]相比，HashSet中的數據無序存放，而TreeSet是有序存放。它們集合中的元素都不允許重復，但HashSet允許放入null值，TreeSet不建議存放null值，可能會對排序結果產生影響。

推薦使用場景： 一般需要存儲有序集合的場景，可以使用TreeSet。

文檔中存在泛型的使用，涉及以下泛型標記符：

• T：Type，類

說明：

本模塊首批接口從API version 8開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。

導入模塊

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

TreeSet

鴻蒙開發指導文檔：qr23.cn/FBD4cY點擊或者復制轉到。

屬性

系統能力： SystemCapability.Utils.Lang

constructor

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

TreeSet的構造函數，支持通過比較函數對元素進行升序或降序排序。

系統能力： SystemCapability.Utils.Lang

參數：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

let treeSet = new TreeSet();
//使用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.log("TreeSet:" + item);
}

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.add(123);
let result = treeSet.has(123);

getFirstValue

getFirstValue(): T

獲取容器中排序第一的數據，為空時返回undefined。

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

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

getLastValue

getLastValue(): T

獲取容器中排序最后的數據，為空時返回undefined。

系統能力： 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

獲取容器中比傳入元素排序靠前一位的元素，為空時返回undefined。

系統能力： 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

獲取容器中比傳入元素排序靠后一位的元素，為空時返回undefined。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

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

popFirst

popFirst(): T

刪除容器中排序最前的數據，為空時返回undefined。

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

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

popLast

popLast(): T

刪除容器中排序最后的數據，為空時返回undefined。

系統能力： 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

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

系統能力： 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) => 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

返回一個迭代器，迭代器的每一項都是一個JavaScript對象，并返回該對象。

系統能力： SystemCapability.Utils.Lang

返回值：

HarmonyOS與OpenHarmony鴻蒙文檔籽料：mau123789是v直接拿

錯誤碼：

以下錯誤碼的詳細介紹請參見[語言基礎類庫錯誤碼]。

示例：

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;
}

審核編輯 黃宇