js-apis-hashmap.md 8.2 KB
Newer Older
L
linhaoran 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
# 非线性容器HashMap 

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块

```
import {HashMap} from '@ohos.util.HashMap'  
```


## 权限



## HashMap


### 属性

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| length | number | 是 | 否 | HashMap的元素个数 |


### constructor

constructor();

HashMap的构造函数。

- 示例:
  ```
  let hashMap = new HashMap();
  ```


### isEmpty

isEmpty(): boolean;

判断该HashMap是否为空。

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 为空返回true, 不为空返回false |

- 示例:
  ```
  const hashMap = new HashMap();
  hashMap.isEmpty();
  ```


### hasKey

hasKey(key: K): boolean;

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

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | K | 是 | 指定元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 是否包含指定元素 |

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
  hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
  hashMap.hasKey("Ahfbrgrbgnutfodgorrogorgrogofdfdf");
  ```


### hasValue

hasValue(value: V): boolean;

判断此HashMap中是否含有该指定value。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | V | 是 | 指定元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 是否包含指定元素 |

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.hasValue(123);
  hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
  hashMap.hasValue(123);
  ```


### get

get(key: K): V;

获取指定key所对应的value。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | K | 是 | 查找的指定key |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | V | 返回key映射的value值 |

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
  hashMap.set("sdfs", 356);
  hashMap.get("sdfs");
  ```


### setAll

setAll(map: HashMap<K, V>): void;

将一个HashMap中的所有元素组添加到另一个hashmap中。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | map | HashMap<K, V> | 是 | 被添加元素的hashmap |

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
  hashMap.set("sdfs", 356);
  let newHashMap = new HashMap();
  hashMap.setAll(newHashMap);
  ```


### set

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

向HashMap中添加一组数据。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | K | 是 | 添加成员数据的键名 |
  | value | V | 是 | 添加成员数据的值 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | Object | 返回添加后的hashmap |

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
  ```


### remove

remove(key: K): V;

删除指定的元素。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | K | 是 | 依据key指定删除的元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | V | 返回删除元素的值 |

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
  hashMap.set("sdfs", 356);
  hashMap.remove("sdfs");
  ```


### clear

clear(): void;

清除HashMap中的所有元素,并把length置为0。

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
  hashMap.set("sdfs", 356);
  hashMap.clear();
  ```


### keys

keys(): IterableIterator&lt;K&gt;;

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

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

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
  hashMap.set("sdfs", 356);
  let iter = hashMap.keys();
  let temp = iter.next().value;
  while(temp != undefined) {
    console.log(temp);
    temp = iter.next().value;
  }
  ```


### values

values(): IterableIterator&lt;V&gt;;

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

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

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
  hashMap.set("sdfs", 356);
  let iter = hashMap.values();
  let temp = iter.next().value;
  while(temp != undefined) {
    console.log(temp);
    temp = iter.next().value;
  }
  ```


### replace

replace(key: K, value: V): boolean;

对HashMap中一组数据进行更新(替换)。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | key | K | 是 | 依据key指定替换的元素 |
  | value | V | 是 | 添加成员数据的值 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 是否成功对已有数据进行替换 |

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.set("sdfs", 123);
  hashMap.replace("sdfs", 357);
  ```


### forEach

forEach(callbackfn: (value: V, key?: K, hashMap?: HashMap<K, V>) => void, thisArg?: Object): void;

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

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callbackfn | function | 是 | 回调函数 |
  | thisArg | Object | 否 | callbackfn被调用时用作this值 |

- callbackfn的参数说明
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | V | 是 | 当前遍历到的元素键值对的值 |
  | key | K | 是 | 当前遍历到的元素键值对的键 |
  | hashMap | HashMap<K, V> | 否 | 当前调用forEach方法的实例对象 |

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.set("sdfs", 123);
  hashMap.set("dfsghsf", 357);
  hashMap.forEach((value, key) => {
    console.log(value, key);
  });
  ```


### entries

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

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

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

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
  hashMap.set("sdfs", 356);
  let iter = hashMap.entries();
  let temp = iter.next().value;
  while(temp != undefined) {
    console.log(temp[0]);
    console.log(temp[1]);
    temp = iter.next().value;
  }
  ```


### [Symbol.iterator]

[Symbol.iterator]\(): IterableIterator&lt;[K, V]&gt;;

返回一个迭代器,迭代器的每一项都是一个 JavaScript 对象,并返回该对象。

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

- 示例:
  ```
  let hashMap = new HashMap();
  hashMap.set("Ahfbrgrbgnutfodgorrogorgrogofdfdf", 123);
  hashMap.set("sdfs", 356);

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

  // 使用方法二:
  let iter = hashMap[Symbol.iterator]();
  let temp = iter.next().value;
  while(temp != undefined) {
    console.log(temp[0]);
    console.log(temp[1]);
    temp = iter.next().value;
  }
  ```