Class MultiMap<K, V>

A multimap is a variation of a Map that has potentially multiple values for every key.

Type Parameters

Index

Constructors

constructor

new MultiMap<K, V>(): MultiMap<K, V>
Type Parameters
- K
- V
Returns MultiMap<K, V>
- Defined in packages/langium/src/utils/collections.ts:17
new MultiMap<K, V>(elements: [K, V][]): MultiMap<K, V>
Type Parameters
- K
- V
Parameters
- elements: [K, V][]
Returns MultiMap<K, V>
- Defined in packages/langium/src/utils/collections.ts:18

Accessors

size

get size(): number
The total number of values in the multimap.

Returns number
- Defined in packages/langium/src/utils/collections.ts:30

Methods

[iterator]

"[iterator]"(): Iterator<[K, V]>
Returns an iterator of key, value pairs for every entry in the map.

Returns Iterator<[K, V]>
- Defined in packages/langium/src/utils/collections.ts:142

add

add(key: K, value: V): this
Add the given key / value pair to the multimap.
Parameters
- key: K
- value: V
Returns this
- Defined in packages/langium/src/utils/collections.ts:109

addAll

addAll(key: K, values: Iterable<V>): this
Add the given set of key / value pairs to the multimap.
Parameters
- key: K
- values: Iterable<V>
Returns this
- Defined in packages/langium/src/utils/collections.ts:121

clear

clear(): void
Clear all entries in the multimap.

Returns void
- Defined in packages/langium/src/utils/collections.ts:37

delete

delete(key: K, value?: V): boolean
Operates differently depending on whether a value is given:
- With a value, this method deletes the specific key / value pair from the multimap.
- Without a value, all values associated with the given key are deleted.
Parameters
- key: K
- Optionalvalue: V
Returns boolean
true if a value existed and has been removed, or false if the specified key / value does not exist.
- Defined in packages/langium/src/utils/collections.ts:49

entries

entries(): Stream<[K, V]>
Returns a stream of key, value pairs for every entry in the map.

Returns Stream<[K, V]>
- Defined in packages/langium/src/utils/collections.ts:149

entriesGroupedByKey

entriesGroupedByKey(): Stream<[K, V[]]>
Returns a stream of key, value set pairs for every key in the map.

Returns Stream<[K, V[]]>
- Defined in packages/langium/src/utils/collections.ts:171

forEach

forEach(callbackfn: (value: V, key: K, map: this) => void): void
Invokes the given callback function for every key / value pair in the multimap.
Parameters
- callbackfn: (value: V, key: K, map: this) => void
Returns void
- Defined in packages/langium/src/utils/collections.ts:133

get

get(key: K): readonly V[]
Returns an array of all values associated with the given key. If no value exists, an empty array is returned.

Note: The returned array is assumed not to be modified. Use the set method to add a value and delete to remove a value from the multimap.
Parameters
- key: K
Returns readonly V[]
- Defined in packages/langium/src/utils/collections.ts:76

getStream

getStream(key: K): Stream<V>
Returns a stream of all values associated with the given key. If no value exists, EMPTY_STREAM is returned.
Parameters
- key: K
Returns Stream<V>
- Defined in packages/langium/src/utils/collections.ts:84

has

has(key: K, value?: V): boolean
Operates differently depending on whether a value is given:
- With a value, this method returns true if the specific key / value pair is present in the multimap.
- Without a value, this method returns true if the given key is present in the multimap.
Parameters
- key: K
- Optionalvalue: V
Returns boolean
- Defined in packages/langium/src/utils/collections.ts:94

keys

keys(): Stream<K>
Returns a stream of keys in the map.

Returns Stream<K>
- Defined in packages/langium/src/utils/collections.ts:157

values

values(): Stream<V>
Returns a stream of values in the map.

Returns Stream<V>
- Defined in packages/langium/src/utils/collections.ts:164

Class MultiMap<K, V>

Type Parameters

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Returns MultiMap<K, V>

Type Parameters

Parameters

Returns MultiMap<K, V>

Accessors

size

Returns number

Methods

[iterator]

Returns Iterator<[K, V]>

add

Parameters

Returns this

addAll

Parameters

Returns this

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns Stream<[K, V]>

entriesGroupedByKey

Returns Stream<[K, V[]]>

forEach

Parameters

Returns void

get

Parameters

Returns readonly V[]

getStream

Parameters

Returns Stream<V>

has

Parameters

Returns boolean

keys

Returns Stream<K>

values

Returns Stream<V>

Settings

On This Page