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

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从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 51 52
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

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 80 81
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

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 116 117
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

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 154 155
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

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 192 193
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

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 224 225
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

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 256 257
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

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
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
284
| map | TreeMap<K, V> | 是 | 被添加元素的treeMap。 |
Z
zengyawen 已提交
285

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

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

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 301 302
let map = new TreeMap();
treeMap.setAll(map);
```
L
linhaoran 已提交
303 304 305


### set
306

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

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

Z
zengyawen 已提交
311 312
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
313 314 315 316 317 318
**参数:**

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

Z
zengyawen 已提交
320
**返回值:**
L
linhaoran 已提交
321

Z
zengyawen 已提交
322 323
| 类型 | 说明 |
| -------- | -------- |
324
| Object | 返回添加后的treeMap |
Z
zengyawen 已提交
325

L
liu-ganlin 已提交
326 327 328 329
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
330
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
331 332 333
| -------- | -------- |
| 10200011 | The set method cannot be bound. |

Z
zengyawen 已提交
334 335
**示例:**

336
```ts
Z
zengyawen 已提交
337
let treeMap = new TreeMap();
L
lengchangjing 已提交
338
treeMap.set("squirrel", 123);
Z
zengyawen 已提交
339
```
L
linhaoran 已提交
340 341 342 343


### remove

344
remove(key: K): V
L
linhaoran 已提交
345

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

Z
zengyawen 已提交
348 349
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
350 351 352 353
**参数:**

| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
354
| key | K | 是 | 指定key。 |
Z
zengyawen 已提交
355 356

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

Z
zengyawen 已提交
358 359 360
| 类型 | 说明 |
| -------- | -------- |
| V | 返回删除元素的值。 |
L
linhaoran 已提交
361

L
liu-ganlin 已提交
362 363 364 365
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
366
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
367 368 369
| -------- | -------- |
| 10200011 | The remove method cannot be bound. |

Z
zengyawen 已提交
370 371
**示例:**

372
```ts
Z
zengyawen 已提交
373
let treeMap = new TreeMap();
L
lengchangjing 已提交
374 375 376
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
treeMap.remove("sparrow");
Z
zengyawen 已提交
377
```
L
linhaoran 已提交
378 379


380
### getLowerKey
L
linhaoran 已提交
381

382
getLowerKey(key: K): K
L
linhaoran 已提交
383 384 385

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

Z
zengyawen 已提交
386 387
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
388 389 390 391 392 393 394
**参数:**

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

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

Z
zengyawen 已提交
396 397 398
| 类型 | 说明 |
| -------- | -------- |
| K | 返回排序中key前一位的数据。 |
L
linhaoran 已提交
399

L
liu-ganlin 已提交
400 401 402 403
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
404
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
405 406 407
| -------- | -------- |
| 10200011 | The getLowerKey method cannot be bound. |

Z
zengyawen 已提交
408 409
**示例:**

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


419
### getHigherKey
L
linhaoran 已提交
420

421
getHigherKey(key: K): K
L
linhaoran 已提交
422 423 424

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

Z
zengyawen 已提交
425 426
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
427
**参数:**
L
linhaoran 已提交
428

Z
zengyawen 已提交
429 430 431
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| key | K | 是 | 对比的key值。 |
L
linhaoran 已提交
432

Z
zengyawen 已提交
433 434 435 436 437 438
**返回值:**

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

L
liu-ganlin 已提交
439 440 441 442
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
443
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
444 445 446
| -------- | -------- |
| 10200011 | The getHigherKey method cannot be bound. |

Z
zengyawen 已提交
447 448
**示例:**

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

### replace
458

459
replace(key: K, newValue: V): boolean
L
linhaoran 已提交
460

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

Z
zengyawen 已提交
463 464
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
465
**参数:**
L
linhaoran 已提交
466

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

Z
zengyawen 已提交
472 473 474 475
**返回值:**

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

L
liu-ganlin 已提交
478 479 480 481
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
482
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
483 484 485
| -------- | -------- |
| 10200011 | The replace method cannot be bound. |

Z
zengyawen 已提交
486 487
**示例:**

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


### clear

Z
zengyawen 已提交
497
clear(): void
L
linhaoran 已提交
498

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

Z
zengyawen 已提交
501 502
**系统能力:** SystemCapability.Utils.Lang

L
liu-ganlin 已提交
503 504 505 506
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
507
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
508 509 510
| -------- | -------- |
| 10200011 | The clear method cannot be bound. |

Z
zengyawen 已提交
511 512
**示例:**

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


### keys

Z
zengyawen 已提交
523
keys(): IterableIterator&lt;K&gt;
L
linhaoran 已提交
524 525 526

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

Z
zengyawen 已提交
527 528
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
529 530 531 532 533 534
**返回值:**

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

L
liu-ganlin 已提交
535 536 537 538
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
539
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
540 541 542
| -------- | -------- |
| 10200011 | The keys method cannot be bound. |

Z
zengyawen 已提交
543 544
**示例:**

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


### values

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

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

Z
zengyawen 已提交
564 565
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
566 567 568 569 570 571
**返回值:**

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

L
liu-ganlin 已提交
572 573 574 575
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
576
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
577 578 579
| -------- | -------- |
| 10200011 | The values method cannot be bound. |

Z
zengyawen 已提交
580 581
**示例:**

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


### forEach

597
forEach(callbackFn: (value?: V, key?: K, map?: TreeMap<K, V>) => void, thisArg?: Object): void
L
linhaoran 已提交
598 599 600

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

Z
zengyawen 已提交
601 602
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
603 604 605 606
**参数:**

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

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

L
liu-ganlin 已提交
617 618 619 620
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
621
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
622 623 624
| -------- | -------- |
| 10200011 | The forEach method cannot be bound. |

Z
zengyawen 已提交
625 626
**示例:**

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


### entries

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

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

Z
zengyawen 已提交
643 644
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
645 646 647 648 649 650
**返回值:**

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

L
liu-ganlin 已提交
651 652 653 654
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
655
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
656 657 658
| -------- | -------- |
| 10200011 | The entries method cannot be bound. |

Z
zengyawen 已提交
659 660
**示例:**

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


### [Symbol.iterator]

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

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

Z
zengyawen 已提交
681 682
**系统能力:** SystemCapability.Utils.Lang

Z
zengyawen 已提交
683 684 685 686 687
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| IterableIterator<[K, V]> | 返回一个迭代器。 |

L
liu-ganlin 已提交
688 689 690 691
**错误码:**

以下错误码的详细介绍请参见[containers错误码](../errorcodes/errorcode-containers.md)

L
liu-ganlin 已提交
692
| 错误码ID | 错误信息 |
L
liu-ganlin 已提交
693 694 695
| -------- | -------- |
| 10200011 | The Symbol.iterator method cannot be bound. |

Z
zengyawen 已提交
696 697
**示例:**

698
```ts
Z
zengyawen 已提交
699
let treeMap = new TreeMap();
L
lengchangjing 已提交
700 701
treeMap.set("squirrel", 123);
treeMap.set("sparrow", 356);
Z
zengyawen 已提交
702 703 704

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

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