TreeMap可用于存儲具有關聯關系的key-value鍵值對集合，存儲元素中key值唯一，每個key對應一個value。

TreeMap底層使用紅黑樹實現，可以利用二叉樹特性快速查找鍵值對。key值有序存儲，可以實現快速的插入和刪除。

TreeMap和[HashMap]相比，HashMap依據鍵的hashCode存取數據，訪問速度較快。而TreeMap是有序存取，效率較低。

推薦使用場景： 一般需要存儲有序鍵值對的場景，可以使用TreeMap。

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

• K：Key，鍵
• V：Value，值

說明：

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

導入模塊

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

TreeMap

屬性

系統能力： SystemCapability.Utils.Lang

鴻蒙開發指導文檔：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]點擊或者復制轉到。

constructor

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

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

系統能力： SystemCapability.Utils.Lang

參數：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
//使用comparator firstValue < secondValue，表示期望結果為升序排序。反之firstValue > secondValue，表示為降序排序。
let treeMap : TreeMap< string,string > = new TreeMap< string,string >((firstValue: string, secondValue: string) : boolean = > {return firstValue > secondValue});
treeMap.set("aa","3");
treeMap.set("dd","1");
treeMap.set("cc","2");
treeMap.set("bb","4");
let numbers = Array.from(treeMap.keys())
for (let item of numbers) {
  console.log("treeMap:" + item);
}

isEmpty

isEmpty(): boolean

判斷該容器是否為空。

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

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

示例：

const treeMap = new TreeMap();
let result = treeMap.isEmpty();

hasKey

hasKey(key: K): boolean

判斷此容器中是否含有該指定key。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
let result = treeMap.hasKey("squirrel");

hasValue

hasValue(value: V): boolean

判斷此容器中是否含有該指定value。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
let result = treeMap.hasValue(123);

get

get(key: K): V

獲取指定key所對應的value，為空時返回undefined。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let result = treeMap.get("sparrow");

getFirstKey

getFirstKey(): K

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

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let result = treeMap.getFirstKey();

getLastKey

getLastKey(): K

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

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let result = treeMap.getLastKey();

setAll

setAll(map: TreeMap): void

將一個TreeMap中的所有元素組添加到另一個TreeMap中。

系統能力： SystemCapability.Utils.Lang

參數：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let map = new TreeMap();
map.set("demo", 12);
map.setAll(treeMap); // 將treeMap中的所有元素添加到map中
map.forEach((value, key) = > {
  console.log("value" + value, "key" + key); // 打印結果 12 demo、356 sparrow、123 squirrel
})

set

set(key: K, value: V): Object

向容器中添加一組數據。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);

remove

remove(key: K): V

刪除指定key對應的元素。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let result = treeMap.remove("sparrow");

getLowerKey

getLowerKey(key: K): K

獲取容器中等于key或者比傳入key排序靠前一位的key，為空時返回undefined。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
treeMap.set("gander", 356);
let result = treeMap.getLowerKey("sparrow");

getHigherKey

getHigherKey(key: K): K

獲取容器中等于key或者比傳入key排序靠后一位的key，為空時返回undefined。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
treeMap.set("gander", 356);
let result = treeMap.getHigherKey("sparrow");

replace

replace(key: K, newValue: V): boolean

對容器中一組數據進行更新（替換）。

系統能力： SystemCapability.Utils.Lang

參數：

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("sparrow", 123);
let result = treeMap.replace("sparrow", 357);

clear

clear(): void

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

系統能力： SystemCapability.Utils.Lang

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
treeMap.clear();

keys

keys(): IterableIterator

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

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let iter = treeMap.keys();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("value:" + temp);
  temp = iter.next().value;
}

values

values(): IterableIterator

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

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let iter = treeMap.values();
let temp = iter.next().value;
while(temp != undefined) {
  console.log("value:" + temp);
  temp = iter.next().value;
}

forEach

forEach(callbackFn: (value?: V, key?: K, map?: TreeMap) => void, thisArg?: Object): void

通過回調函數來遍歷實例對象上的元素以及元素對應的下標。

系統能力： SystemCapability.Utils.Lang

參數：

callbackFn的參數說明：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("sparrow", 123);
treeMap.set("gull", 357);
treeMap.forEach((value, key) = > {
    console.log("value:" + value, "key:" + key);
});

entries

entries(): IterableIterator<[K, V]>

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

系統能力： SystemCapability.Utils.Lang

返回值：

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let iter = treeMap.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<[K, V]>

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

系統能力： SystemCapability.Utils.Lang

返回值：

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

錯誤碼：

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

示例：

let treeMap = new TreeMap();
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);

// 使用方法一：
for (let item of treeMap) { 
  console.log("key:" + item[0]);
  console.log("value:" + item[1]);
}

// 使用方法二：
let iter = treeMap[Symbol.iterator]();
let temp: IteratorResult< Object[] > = iter.next();
while(!temp.done) {
  console.log("key:" + temp.value[0]);
  console.log("value:" + temp.value[1]);
  temp = iter.next();
}

審核編輯 黃宇