Class: MultiMap

Constructor

new MultiMap(valuesopt)

Constructor.

Parameters:

Name	Type	Attributes	Description
`values`	*	<optional>	an object who's enumerable properties will be added to this map

Source: util/multiMap.js, line 8

Methods

add(key, value) → {module:util~MutliMap}

Add a value.

This method will append values to existing keys.

Parameters:

Name	Type	Description
`key`	string	the key to use
`value`	*	the value to add; if `undefined` nothing will be added

Source: util/multiMap.js, line 31

Returns:

this object

Type:: module:util~MutliMap

clear() → {module:util~MutliMap}

Remove all properties from this map.

Source: util/multiMap.js, line 93

Returns:

this object

Type:: module:util~MutliMap

containsKey(key) → {boolean}

Test if there are any values associated with a key.

Parameters:

Name	Type	Description
`key`	string	the key to test

Source: util/multiMap.js, line 140

Returns:

true if there is at least one value associated with the key

Type:: boolean

firstValue(key) → {*}

Get the first avaialble value assocaited with a key.

Parameters:

Name	Type	Description
`key`	string	the key of the value to get

Source: util/multiMap.js, line 83

Returns:

the first available value associated with the key, or undefined if not available

Type:: *

isEmpty() → {boolean}

Test if the map is empty.

Source: util/multiMap.js, line 130

Returns:

true if there are no entries in this map

Type:: boolean

keySet() → {Array.<string>}

Get an array of all keys in this map.

Source: util/multiMap.js, line 149

Returns:

array of keys in this map, or an empty array if the map is empty

Type:: Array.<string>

put(key, value) → {module:util~MutliMap}

Set a value.

This method will replace any existing values with just value.

Parameters:

Name	Type	Description
`key`	string	the key to use
`value`	*	the value to set; if `undefined` nothing will be added

Source: util/multiMap.js, line 44

Returns:

this object

Type:: module:util~MutliMap

putAll(values) → {module:util~MutliMap}

Set multiple values.

This method will replace any existing values with those provided on values.

Parameters:

Name	Type	Description
`values`	*	an object who's enumerable properties will be added to this map

Source: util/multiMap.js, line 56

Returns:

this object

Type:: module:util~MutliMap

remove(key) → {Array.<object>}

Remove all values associated with a key.

Parameters:

Name	Type	Description
`key`	string	the key of the values to remove

Source: util/multiMap.js, line 105

Returns:

the removed values, or undefined if no values were present for the given key

Type:: Array.<object>

size() → {number}

Get the number of entries in this map.

Source: util/multiMap.js, line 121

Returns:

the number of entries in the map

Type:: number

value(key) → {Array.<object>}

Get the values associated with a key.

Parameters:

Name	Type	Description
`key`	string	the key of the values to get

Source: util/multiMap.js, line 71

Returns:

the array of values associated with the key, or undefined if not available

Type:: Array.<object>