js-apis-treemap.md 16.2 KB
Newer Older
1
# @ohos.util.TreeMap (非线性容器TreeMap) 
L
linhaoran 已提交
2

zyjhandsome's avatar
zyjhandsome 已提交
3
> **说明:**
L
linhaoran 已提交
4 5
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

6 7 8 9 10 11 12
TreeMap可用于存储具有关联关系的key-value键值对集合,存储元素中key值唯一,每个key对应一个value。

TreeMap底层使用红黑树实现,可以利用二叉树特性快速查找键值对。key值有序存储,可以实现快速的插入和删除。

TreeMap和[HashMap](js-apis-treemap.md)相比,HashMap依据键的hashCode存取数据,访问速度较快。而TreeMap是有序存取,效率较低。

**推荐使用场景:** 一般需要存储有序键值对的场景,可以使用TreeMap。
L
linhaoran 已提交
13

L
lengchangjing 已提交
14 15 16 17
文档中存在泛型的使用,涉及以下泛型标记符:<br>
- K: Key, 键<br>
- V: Value, 值

L
linhaoran 已提交
18 19
## 导入模块

20
```ts
21
import TreeMap from '@ohos.util.TreeMap';  
L
linhaoran 已提交
22 23 24 25 26 27
```

## TreeMap

### 属性

Z
zengyawen 已提交
28 29
**系统能力:** SystemCapability.Utils.Lang

L
liu-ganlin 已提交
30
| 名称 | 类型 | 可读 | 可写 | 说明 |
L
linhaoran 已提交
31
| -------- | -------- | -------- | -------- | -------- |
32
| length | number | 是 | 否 | TreeMap的元素个数。 |
L
linhaoran 已提交
33 34 35 36


### constructor

Z
zengyawen 已提交
37
constructor(comparator?:(firstValue: K, secondValue: K) => boolean)
L
linhaoran 已提交
38 39 40

TreeMap的构造函数。

Z
zengyawen 已提交
41 42
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
43 44 45 46 47 48
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| comparator | function | 否 | 用户自定义的比较函数。 |

L
liu-ganlin 已提交
49 50
**错误码:**

B
bi-hu 已提交
51
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
52

L
liu-ganlin 已提交
53
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
54 55 56
| -------- | -------- |
| 10200012 | The TreeMap's constructor cannot be directly invoked. |

Z
zengyawen 已提交
57
**示例:**
L
linhaoran 已提交
58

59
```ts
Z
zengyawen 已提交
60 61
let treeMap = new TreeMap();
```
L
linhaoran 已提交
62 63 64 65


### isEmpty

66
isEmpty(): boolean
L
linhaoran 已提交
67 68 69

判断该容器是否为空。

Z
zengyawen 已提交
70 71
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
72 73 74 75 76
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| boolean | 为空返回true,否则返回false。 |
L
linhaoran 已提交
77

L
liu-ganlin 已提交
78 79
**错误码:**

B
bi-hu 已提交
80
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
81

L
liu-ganlin 已提交
82
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
83 84 85
| -------- | -------- |
| 10200011 | The isEmpty method cannot be bound. |

Z
zengyawen 已提交
86 87
**示例:**

88
```ts
Z
zengyawen 已提交
89
const treeMap = new TreeMap();
90
let result = treeMap.isEmpty();
Z
zengyawen 已提交
91
```
L
linhaoran 已提交
92 93 94 95


### hasKey

96
hasKey(key: K): boolean
L
linhaoran 已提交
97 98 99

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

Z
zengyawen 已提交
100 101
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
102
**参数:**
L
linhaoran 已提交
103

Z
zengyawen 已提交
104 105
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
106
| key | K | 是 | 指定key |
L
linhaoran 已提交
107

Z
zengyawen 已提交
108 109 110 111
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
112
| boolean | 包含指定key返回true,否则返回false。 |
Z
zengyawen 已提交
113

L
liu-ganlin 已提交
114 115
**错误码:**

B
bi-hu 已提交
116
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
117

L
liu-ganlin 已提交
118
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
119 120 121
| -------- | -------- |
| 10200011 | The hasKey method cannot be bound. |

Z
zengyawen 已提交
122 123
**示例:**

124
```ts
Z
zengyawen 已提交
125
let treeMap = new TreeMap();
L
lengchangjing 已提交
126 127 128
let result = treeMap.hasKey("squirrel");
treeMap.set("squirrel", 123);
let result1 = treeMap.hasKey("squirrel");
Z
zengyawen 已提交
129
```
L
linhaoran 已提交
130 131 132 133


### hasValue

Z
zengyawen 已提交
134
hasValue(value: V): boolean
L
linhaoran 已提交
135

W
wusongqing 已提交
136
判断此容器中是否含有该指定value。
L
linhaoran 已提交
137

Z
zengyawen 已提交
138 139
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
140 141 142 143
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
W
wusongqing 已提交
144
| value | V | 是 | 指定value。 |
L
linhaoran 已提交
145

Z
zengyawen 已提交
146
**返回值:**
L
linhaoran 已提交
147

Z
zengyawen 已提交
148 149 150 151
| 类型 | 说明 |
| -------- | -------- |
| boolean | 包含指定元素返回true,否则返回false。 |

L
liu-ganlin 已提交
152 153
**错误码:**

B
bi-hu 已提交
154
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
155

L
liu-ganlin 已提交
156
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
157 158 159
| -------- | -------- |
| 10200011 | The hasValue method cannot be bound. |

Z
zengyawen 已提交
160 161
**示例:**

162
```ts
Z
zengyawen 已提交
163
let treeMap = new TreeMap();
164
let result = treeMap.hasValue(123);
L
lengchangjing 已提交
165
treeMap.set("squirrel", 123);
166
let result1 = treeMap.hasValue(123);
Z
zengyawen 已提交
167
```
L
linhaoran 已提交
168 169 170 171


### get

Z
zengyawen 已提交
172
get(key: K): V
L
linhaoran 已提交
173 174 175

获取指定key所对应的value。

Z
zengyawen 已提交
176 177
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
178 179 180 181
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
182
| key | K | 是 | 指定key。 |
Z
zengyawen 已提交
183 184

**返回值:**
L
linhaoran 已提交
185

Z
zengyawen 已提交
186 187 188
| 类型 | 说明 |
| -------- | -------- |
| V | 返回key映射的value值。 |
L
linhaoran 已提交
189

L
liu-ganlin 已提交
190 191
**错误码:**

B
bi-hu 已提交
192
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
193

L
liu-ganlin 已提交
194
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
195 196 197
| -------- | -------- |
| 10200011 | The get method cannot be bound. |

Z
zengyawen 已提交
198 199
**示例:**

200
```ts
Z
zengyawen 已提交
201
let treeMap = new TreeMap();
L
lengchangjing 已提交
202 203 204
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
let result = treeMap.get("sparrow");
Z
zengyawen 已提交
205
```
L
linhaoran 已提交
206 207 208 209


### getFirstKey

210
getFirstKey(): K
L
linhaoran 已提交
211

212
获取容器中排序第一的key。
L
linhaoran 已提交
213

Z
zengyawen 已提交
214 215
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
216 217 218 219
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
220
| K | 返回排序第一的key。 |
Z
zengyawen 已提交
221

L
liu-ganlin 已提交
222 223
**错误码:**

B
bi-hu 已提交
224
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
225

L
liu-ganlin 已提交
226
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
227 228 229
| -------- | -------- |
| 10200011 | The getFirstKey method cannot be bound. |

Z
zengyawen 已提交
230
**示例:**
L
linhaoran 已提交
231

232
```ts
Z
zengyawen 已提交
233
let treeMap = new TreeMap();
L
lengchangjing 已提交
234 235
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
Z
zengyawen 已提交
236 237
let result = treeMap.getFirstKey();
```
L
linhaoran 已提交
238 239 240 241


### getLastKey

242
getLastKey(): K
L
linhaoran 已提交
243

244
获取容器中排序最后的key。
L
linhaoran 已提交
245

Z
zengyawen 已提交
246 247
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
248
**返回值:**
L
linhaoran 已提交
249

Z
zengyawen 已提交
250 251
| 类型 | 说明 |
| -------- | -------- |
252
| K | 返回排序最后的key |
Z
zengyawen 已提交
253

L
liu-ganlin 已提交
254 255
**错误码:**

B
bi-hu 已提交
256
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
257

L
liu-ganlin 已提交
258
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
259 260 261
| -------- | -------- |
| 10200011 | The getLastKey method cannot be bound. |

Z
zengyawen 已提交
262 263
**示例:**

264
```ts
Z
zengyawen 已提交
265
let treeMap = new TreeMap();
L
lengchangjing 已提交
266 267
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
Z
zengyawen 已提交
268 269
let result = treeMap.getLastKey();
```
L
linhaoran 已提交
270 271 272 273


### setAll

Z
zengyawen 已提交
274
setAll(map: TreeMap<K, V>): void
L
linhaoran 已提交
275

276
将一个TreeMap中的所有元素组添加到另一个TreeMap中。
L
linhaoran 已提交
277

Z
zengyawen 已提交
278 279
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
280 281 282 283
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
B
bi-hu 已提交
284
| map | TreeMap<K, V> | 是 | 该map会添加到其调用setAll接口的map对象中。 |
Z
zengyawen 已提交
285

L
liu-ganlin 已提交
286 287
**错误码:**

B
bi-hu 已提交
288
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
289

L
liu-ganlin 已提交
290
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
291 292 293
| -------- | -------- |
| 10200011 | The setAll method cannot be bound. |

Z
zengyawen 已提交
294
**示例:**
L
linhaoran 已提交
295

296
```ts
Z
zengyawen 已提交
297
let treeMap = new TreeMap();
L
lengchangjing 已提交
298 299
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
Z
zengyawen 已提交
300
let map = new TreeMap();
B
bi-hu 已提交
301 302 303 304 305
map.set("demo", 12);
map.setAll(treeMap); // 将treeMap中的所有元素添加到map中
map.forEach((value, key) => {
    console.log("test" + value, key); // 打印结果 12 demo、356 sparrow、123 squirrel
})
Z
zengyawen 已提交
306
```
L
linhaoran 已提交
307 308 309


### set
310

Z
zengyawen 已提交
311
set(key: K, value: V): Object
L
linhaoran 已提交
312

313
向容器中添加一组数据。
L
linhaoran 已提交
314

Z
zengyawen 已提交
315 316
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
317 318 319 320 321 322
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | K | 是 | 添加成员数据的键名。 |
| value | V | 是 | 添加成员数据的值。 |
L
linhaoran 已提交
323

Z
zengyawen 已提交
324
**返回值:**
L
linhaoran 已提交
325

Z
zengyawen 已提交
326 327
| 类型 | 说明 |
| -------- | -------- |
328
| Object | 返回添加后的treeMap |
Z
zengyawen 已提交
329

L
liu-ganlin 已提交
330 331
**错误码:**

B
bi-hu 已提交
332
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
333

L
liu-ganlin 已提交
334
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
335 336 337
| -------- | -------- |
| 10200011 | The set method cannot be bound. |

Z
zengyawen 已提交
338 339
**示例:**

340
```ts
Z
zengyawen 已提交
341
let treeMap = new TreeMap();
L
lengchangjing 已提交
342
treeMap.set("squirrel", 123);
Z
zengyawen 已提交
343
```
L
linhaoran 已提交
344 345 346 347


### remove

348
remove(key: K): V
L
linhaoran 已提交
349

350
删除指定key对应的元素。
L
linhaoran 已提交
351

Z
zengyawen 已提交
352 353
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
354 355 356 357
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
358
| key | K | 是 | 指定key。 |
Z
zengyawen 已提交
359 360

**返回值:**
L
linhaoran 已提交
361

Z
zengyawen 已提交
362 363 364
| 类型 | 说明 |
| -------- | -------- |
| V | 返回删除元素的值。 |
L
linhaoran 已提交
365

L
liu-ganlin 已提交
366 367
**错误码:**

B
bi-hu 已提交
368
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
369

L
liu-ganlin 已提交
370
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
371 372 373
| -------- | -------- |
| 10200011 | The remove method cannot be bound. |

Z
zengyawen 已提交
374 375
**示例:**

376
```ts
Z
zengyawen 已提交
377
let treeMap = new TreeMap();
L
lengchangjing 已提交
378 379 380
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
treeMap.remove("sparrow");
Z
zengyawen 已提交
381
```
L
linhaoran 已提交
382 383


384
### getLowerKey
L
linhaoran 已提交
385

386
getLowerKey(key: K): K
L
linhaoran 已提交
387 388 389

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

Z
zengyawen 已提交
390 391
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
392 393 394 395 396 397 398
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | K | 是 | 对比的key值。 |

**返回值:**
L
linhaoran 已提交
399

Z
zengyawen 已提交
400 401 402
| 类型 | 说明 |
| -------- | -------- |
| K | 返回排序中key前一位的数据。 |
L
linhaoran 已提交
403

L
liu-ganlin 已提交
404 405
**错误码:**

B
bi-hu 已提交
406
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
407

L
liu-ganlin 已提交
408
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
409 410 411
| -------- | -------- |
| 10200011 | The getLowerKey method cannot be bound. |

Z
zengyawen 已提交
412 413
**示例:**

414
```ts
Z
zengyawen 已提交
415
let treeMap = new TreeMap();
L
lengchangjing 已提交
416 417 418 419
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
treeMap.set("gander", 356);
let result = treeMap.getLowerKey("sparrow");
Z
zengyawen 已提交
420
```
L
linhaoran 已提交
421 422


423
### getHigherKey
L
linhaoran 已提交
424

425
getHigherKey(key: K): K
L
linhaoran 已提交
426 427 428

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

Z
zengyawen 已提交
429 430
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
431
**参数:**
L
linhaoran 已提交
432

Z
zengyawen 已提交
433 434 435
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | K | 是 | 对比的key值。 |
L
linhaoran 已提交
436

Z
zengyawen 已提交
437 438 439 440 441 442
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| K | 返回排序中key后一位的数据。 |

L
liu-ganlin 已提交
443 444
**错误码:**

B
bi-hu 已提交
445
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
446

L
liu-ganlin 已提交
447
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
448 449 450
| -------- | -------- |
| 10200011 | The getHigherKey method cannot be bound. |

Z
zengyawen 已提交
451 452
**示例:**

453
```ts
Z
zengyawen 已提交
454
let treeMap = new TreeMap();
L
lengchangjing 已提交
455 456 457 458
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
treeMap.set("gander", 356);
let result = treeMap.getHigherKey("sparrow");
Z
zengyawen 已提交
459
```
L
linhaoran 已提交
460 461

### replace
462

463
replace(key: K, newValue: V): boolean
L
linhaoran 已提交
464

465
对容器中一组数据进行更新(替换)。
L
linhaoran 已提交
466

Z
zengyawen 已提交
467 468
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
469
**参数:**
L
linhaoran 已提交
470

Z
zengyawen 已提交
471 472
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
473 474
| key | K | 是 | 指定key。 |
| newValue | V | 是 | 替换的元素。 |
L
linhaoran 已提交
475

Z
zengyawen 已提交
476 477 478 479
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
480
| boolean | 对指定key对应的元素替换成功返回true,否则返回false。 |
Z
zengyawen 已提交
481

L
liu-ganlin 已提交
482 483
**错误码:**

B
bi-hu 已提交
484
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
485

L
liu-ganlin 已提交
486
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
487 488 489
| -------- | -------- |
| 10200011 | The replace method cannot be bound. |

Z
zengyawen 已提交
490 491
**示例:**

492
```ts
Z
zengyawen 已提交
493
let treeMap = new TreeMap();
L
lengchangjing 已提交
494 495
treeMap.set("sparrow", 123);
let result = treeMap.replace("sparrow", 357);
Z
zengyawen 已提交
496
```
L
linhaoran 已提交
497 498 499 500


### clear

Z
zengyawen 已提交
501
clear(): void
L
linhaoran 已提交
502

503
清除容器中的所有元素,并把length置为0。
L
linhaoran 已提交
504

Z
zengyawen 已提交
505 506
**系统能力:** SystemCapability.Utils.Lang

L
liu-ganlin 已提交
507 508
**错误码:**

B
bi-hu 已提交
509
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
510

L
liu-ganlin 已提交
511
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
512 513 514
| -------- | -------- |
| 10200011 | The clear method cannot be bound. |

Z
zengyawen 已提交
515 516
**示例:**

517
```ts
Z
zengyawen 已提交
518
let treeMap = new TreeMap();
L
lengchangjing 已提交
519 520
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
Z
zengyawen 已提交
521 522
treeMap.clear();
```
L
linhaoran 已提交
523 524 525 526


### keys

Z
zengyawen 已提交
527
keys(): IterableIterator&lt;K&gt;
L
linhaoran 已提交
528 529 530

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

Z
zengyawen 已提交
531 532
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
533 534 535 536 537 538
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| IterableIterator&lt;K&gt; | 返回一个迭代器。 |

L
liu-ganlin 已提交
539 540
**错误码:**

B
bi-hu 已提交
541
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
542

L
liu-ganlin 已提交
543
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
544 545 546
| -------- | -------- |
| 10200011 | The keys method cannot be bound. |

Z
zengyawen 已提交
547 548
**示例:**

549
```ts
Z
zengyawen 已提交
550
let treeMap = new TreeMap();
L
lengchangjing 已提交
551 552
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
Z
zengyawen 已提交
553 554 555
let iter = treeMap.keys();
let temp = iter.next().value;
while(temp != undefined) {
556
  console.log("value:" + temp);
Z
zengyawen 已提交
557
  temp = iter.next().value;
L
liu-ganlin 已提交
558
}
Z
zengyawen 已提交
559
```
L
linhaoran 已提交
560 561 562 563


### values

Z
zengyawen 已提交
564
values(): IterableIterator&lt;V&gt;
L
linhaoran 已提交
565

W
wusongqing 已提交
566
返回包含此映射中包含的键值的新迭代器对象。
L
linhaoran 已提交
567

Z
zengyawen 已提交
568 569
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
570 571 572 573 574 575
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| IterableIterator&lt;V&gt; | 返回一个迭代器。 |

L
liu-ganlin 已提交
576 577
**错误码:**

B
bi-hu 已提交
578
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
579

L
liu-ganlin 已提交
580
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
581 582 583
| -------- | -------- |
| 10200011 | The values method cannot be bound. |

Z
zengyawen 已提交
584 585
**示例:**

586
```ts
Z
zengyawen 已提交
587
let treeMap = new TreeMap();
L
lengchangjing 已提交
588 589
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
Z
zengyawen 已提交
590 591 592
let iter = treeMap.values();
let temp = iter.next().value;
while(temp != undefined) {
593
  console.log("value:" + temp);
Z
zengyawen 已提交
594 595 596
  temp = iter.next().value;
}
```
L
linhaoran 已提交
597 598 599 600


### forEach

601
forEach(callbackFn: (value?: V, key?: K, map?: TreeMap<K, V>) => void, thisArg?: Object): void
L
linhaoran 已提交
602 603 604

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

Z
zengyawen 已提交
605 606
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
607 608 609 610
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
611
| callbackFn | function | 是 | 回调函数。 |
Z
zengyawen 已提交
612 613 614 615 616
| thisArg | Object | 否 | callbackfn被调用时用作this值。 |

callbackfn的参数说明:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
617 618
| value | V | 否 | 当前遍历到的元素键值对的值。 |
| key | K | 否 | 当前遍历到的元素键值对的键。 |
619
| map | TreeMap<K, V> | 否 | 当前调用forEach方法的实例对象。 |
Z
zengyawen 已提交
620

L
liu-ganlin 已提交
621 622
**错误码:**

B
bi-hu 已提交
623
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
624

L
liu-ganlin 已提交
625
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
626 627 628
| -------- | -------- |
| 10200011 | The forEach method cannot be bound. |

Z
zengyawen 已提交
629 630
**示例:**

631
```ts
Z
zengyawen 已提交
632
let treeMap = new TreeMap();
L
lengchangjing 已提交
633 634
treeMap.set("sparrow", 123);
treeMap.set("gull", 357);
Z
zengyawen 已提交
635
treeMap.forEach((value, key) => {
636
  console.log("value:" + value, key);
Z
zengyawen 已提交
637 638
});
```
L
linhaoran 已提交
639 640 641 642


### entries

Z
zengyawen 已提交
643
entries(): IterableIterator<[K, V]>
L
linhaoran 已提交
644

645
返回包含此映射中包含的键值对的新迭代器对象。
L
linhaoran 已提交
646

Z
zengyawen 已提交
647 648
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
649 650 651 652 653 654
**返回值:**

| 类型 | 说明 |
| -------- | -------- |
| IterableIterator<[K, V]> | 返回一个迭代器。 |

L
liu-ganlin 已提交
655 656
**错误码:**

B
bi-hu 已提交
657
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
658

L
liu-ganlin 已提交
659
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
660 661 662
| -------- | -------- |
| 10200011 | The entries method cannot be bound. |

Z
zengyawen 已提交
663 664
**示例:**

665
```ts
Z
zengyawen 已提交
666
let treeMap = new TreeMap();
L
lengchangjing 已提交
667 668
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
Z
zengyawen 已提交
669 670 671
let iter = treeMap.entries();
let temp = iter.next().value;
while(temp != undefined) {
672 673
  console.log("key:" + temp[0]);
  console.log("value:" + temp[1]);
Z
zengyawen 已提交
674 675 676
  temp = iter.next().value;
}
```
L
linhaoran 已提交
677 678 679 680


### [Symbol.iterator]

681
[Symbol.iterator]\(): IterableIterator&lt;[K, V]&gt;
L
linhaoran 已提交
682

Z
zengyawen 已提交
683 684
返回一个迭代器,迭代器的每一项都是一个 JavaScript 对象,并返回该对象。

Z
zengyawen 已提交
685 686
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
687 688 689 690 691
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| IterableIterator<[K, V]> | 返回一个迭代器。 |

L
liu-ganlin 已提交
692 693
**错误码:**

B
bi-hu 已提交
694
以下错误码的详细介绍请参见[语言基础类库错误码](../errorcodes/errorcode-utils.md)
L
liu-ganlin 已提交
695

L
liu-ganlin 已提交
696
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
697 698 699
| -------- | -------- |
| 10200011 | The Symbol.iterator method cannot be bound. |

Z
zengyawen 已提交
700 701
**示例:**

702
```ts
Z
zengyawen 已提交
703
let treeMap = new TreeMap();
L
lengchangjing 已提交
704 705
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
Z
zengyawen 已提交
706 707 708

// 使用方法一:
for (let item of treeMap) { 
709 710
  console.log("key:" + item[0]);
  console.log("value:" + item[1]);
Z
zengyawen 已提交
711 712 713 714 715 716
}

// 使用方法二:
let iter = treeMap[Symbol.iterator]();
let temp = iter.next().value;
while(temp != undefined) {
717 718
  console.log("key:" + temp[0]);
  console.log("value:" + temp[1]);
Z
zengyawen 已提交
719 720 721
  temp = iter.next().value;
}
```